Added total_amount
and amount_remaining
attributes to booking credits.
Added updating the admin name.
Added channels
attribute to activities.
Added has_custom_price
attribute to bookings to indicate that a fixed price has been set
Added event
attribute containing the id
to bookings if they belong to an event
Changed PUT & DELETE /bookings/:booking_id can respond with 409 when the booking has an event.
Added .zip format support to GET /api/invoices endpoint
Added updated_at
& created_at
to bookings
Added updating navigation links.
Added stripe_payment_method_id
which is the id of the payment method used by Stripe for a given customer
Added units
to bookings to allow to book more than one unit at once
Added can_charge
to invoices.
Added accounting_code
to bookings.
Added color
and photo
to plans.
Redirect URI is required for new OAuth clients.
Added preview
param to credentials check-in endpoint.
Added support for OpenID Connect.
Added support for Gocardless to update membership payment method endpoint.
Added space logo endpoint.
Added total_amount
, total_amount_with_taxes
, total_tax_amount
to invoice items.
Added tax_amount
to invoice items.
Added uncanceled_membership webhook.
Added validate_times_for_admin
param to booking endpoints.
Added minimum_commitment
to plan endpoints
Added create/delete guest account endpoints.
Added taxes
to invoices. Deprecated tax_amounts
, tax_rate
.
Added confirmation_date/first_invoice_date to confirm membership endpoint. Added default_invoice_day and next_default_invoice_date to invoice_settings endpoint.
Removed user photo endpoints. Users don't have photos anymore. User photo attributes now return a placeholder.
Added payment method attributes to payment records.
Added rate limiting the API (60 rpm per user, 6 rpm for member list).
Added time to guest account expires_at attribute.
Added /service_charges endpoint. Added /membership/bookings endpoint to get a list of own bookings as member.
Added /email_customizations endpoint.
Added cancel own membership endpoint.
Added invoices search. Added membership_reactivated webhook.
Added /space/custom_fields endpoints for accessing space level custom fields.
Added fetching invoices by ids.
Added creating access tokens for a space.
Added passing ids to /resources.
Added limit parameter to /bookings endpoint.
Added /accounting_codes endpoint.
Added checkin token data to deleted_checkin_token webhook event.
Added photo attribute to /resources endpoints.
Added price_decimals attribute to GET /spaces endpoints.
Added charge_at and due_date to GET api/*/invoices endpoints
Added setting price
when creating/updating a booking.
Added locale to spaces.
Added expires_at
to POST api/memberships/:membership_id/time_passes. Added weekdays to booking_times in /resources endpoint.
Added endpoint for fetching bookings by membership id and timespan. Added endpoint for updating time passes.
Added return_payment_errors query param to invoice charges endpoint.
Added generate_invoices_days_early attribute to invoice settings endpoint.
Added sending valid_from when checking member in.
Added tax_rate to resources.
Added parsed_timespans attribute to time passes endpoints.
Added HTML format to /activities endpoint.
Added updated_membership_picture webhook.
Added booking data to delete_booking webhook, as it's impossible to fetch it after deletion.
Added endpoint for getting bookings of a resource in a certain timspan.
Added membership_cancellation_date_reached webhook.
Added /invoice_settings endpoint.
Added endpoint for deleting an invoice.
Added endpoint for reopening a written off invoice.
Added total_paid_amount to invoices.
Added id to activities.
Added endpoint for retrieving list of unused time passes as member.
Added user_editable to navigation links.
Added prorate_first_invoice attribute to membership creation endpoint.
Added endpoint for generating membership invites.
Added POST /api/password_resets to trigger password reset emails by API
Added updated_membership_details webhook.
Removed membership id from endpoints for showing/deleting a time pass.
Added time_pass attribute to check-ins.
Made invoice endpoints work with invoice ids in addition to invoice numbers (using ids is now preferred).
Added updated_connected_user webhook.
Added passing time pass name when checking in member. Added guest accounts endpoints. Added admin/guest account webhooks.
Added signup_charge to plans. Added endpoints for customizing members' plans.
Added updated_custom_field webhook.
Added booking_times attribute to resources.
Added list of past member plans via GET /memberships/:membership_id/plans
Added included_value/included_unit to booking credits. included_unit is either 'hours' or 'amount'. These replace the hours attribute, which is now deprecated.
Added deleting memberships.
Added listing and creating help desk issues
Added setting invoice status to written_off
Added listing activities by source ids. Added customer_number to invoices.
Added tax_id_name/tax_id to invoices.
Added adding and removing team members
Added listing check-ins of single members for admin (GET /api/memberships/:membership_id/check_ins).
Limits max. date range when requesting bookings to 6 months.
Added email, billing_email and paying_membership_id fields to create membership endpoint.
Added checkin token webhooks and GET /check_in_tokens/:token endpoint.
Added requested_starts_at parameter to api/memberships POST body to set a start date for the membership. Added pre_approved parameter to api/memberships POST body to indicate a membership does not need confirmation.
Added read_subscriptions/write_subscriptions scopes for subscriptions API. Added accounting codes to plans.
Added /api/memberships/:membership_id/user to space api to connect a user to a membership
Added paid_at date in /api/invoices/*
Added amount_with_tax to invoice items in /api/invoices/*
Added endpoints for managing resources.
parent_plan will now tell you the id of the /api/plans that was used as template to create a membership plan in api/memberships/.Added reading of booking_credits of the plan to api/plans/ and api/memberships/*.
Added tax_name
to /api/invoices/*
Fixed return company name as name
in /api/memberships/* if name not set
use same serialization for the plan part at /api/membership endpoint then /api/plans and include tax_rate
. Removed deprecated day_pass_price_in_cents
, max_days_per_timespan
max_days_timespan
from membership.plan
Added check-out webhook.
Added listing memberships by id.
Added can_book
attribute to booking calendar resources.
Added booking categories endpoint.
Added booking passes endpoints.
Added tax_rate to plan. Added customer_number and charge_taxes field to membership responses.
Added tax_rate to one time charges endpoints
Added address details like name, company and country to /api/answers
Added color attribute to resources.
Added PUT /api/membership/plan so that members can change their plan. Added PUT /api/memberships/:membership_id & /api/membership for updating membership details. Added hd image size (1200x1200), added uploading base64 encoded pictures.
Added updating user/member picture.
Added member names to check-ins. Added listing check-ins for a space as member (GET /api/check-ins). Added writing custom fields.
Added POST /api/membership so allow current user to signup for a membership. Added /api/membership so get membership of current user. Added /api/answers to get all answers of members for questionnaire. Added /membership/answers so members can change their questionnaires.
Added revoke access token endpoint. Added username/password authentication for native apps.
Members can now create custom invoices for themselves, charge and send them. Added already_paid
attribute to charges.
Added /payment_records?from=YYYY-MM-DD&to=YYYY-MM-DD
endpoint to query payment records by paid at
Added price_per_cycle
, extras[].price
, extras[].currency
, timepasses[].price
& discounts[].price
to plans
Added accounting_code
to invoice items.
Added webhook for when time passes are removed from a membership. Added total_price_per_cycle
to membership plans.
Added notes
field to invoices (admins only).
Added webhook for when time passes are added to a membership.
Added webhook for check-ins. Added endpoint /check_ins/:id
Added comments
field to bookings.
Added accounting_code
field to charges.
Added min_booking_duration
and max_booking_duration
to resources.
Added returning JSON when creating time passes.
Added passing password when creating user.
Added /charges endpoint.
Added ignoring case of mac addresses used as check-in tokens.
Added downloading invoice PDFs via API. Added changed_membership_plan
webhook.
Changed invoice items to return invoice's tax rate if their own is null.
Added filtering booking subscriptions by resource id.
Added paid_status
to invoices.
Added address
to spaces.
Added phone
to memberships.
Added hour_format
to spaces (whether a country uses a 12h or 24h system).
Added updated_payment_method
webhook. Added automated
attribute to membership payment method.
Added /invoices/:invoice_number/charges
endpoint.
Added /teams
endpoint for admins.
Added ?all=true
to /memberships
endpoint.
Added welcome_message
to plans.
Added endpoint for creating charges based invoices.
Added id
to charges. Added deleting charges.
Added charged_at
and quantity
to charges.
Added custom_domain
attribute to spaces.
Added billing_emails
to memberships. Added GET memberships/:id/custom_fields
endpoint.
Added listing payment records by providing invoice_ids. Added from/to parameters to listing invoices for a membership.
Removed day pass attributes from plans.
Added expires_at
to time passes.
Added GET /check_in
endpoint for retrieving a member's current check-in.
Added webhooks for bookings.
Added cancellation_period
to resources, can_change
to bookings.
Added formatted_invoice_number
to invoices.
The iframe_url
of a navigation link must now use https as browser will block http within https.
Added invoice items endpoints.
Added sent
attribute to invoices.
Added /invoices/:invoice_number/notifications
endpoint for sending invoice emails.
Added POST /memberships/:membership_id/invoices
endpoint for creating invoices.
Added /custom_fields
endpoint.
Added /admins
endpoint. Added /activities
endpoint.
Added full_address
to membership addresses. address
, city
, state
and post_code
should not be used anymore and will be removed in the future.
Changed response code from 200 to 204 when returning an empty response (deleting bookings, deleting bookings).
Removed mac_addresses
and crypted_password
from users.
Added /memberships/:id/picture
endpoint.
Added /membership/bookings/upcoming
enpoint.
Added creating memberships with users and custom plans.
Added /invoices/open
endpoint.
Added id to user memberships.
Creating a membership no more sets up a payment method.
Adds /team
endpoint. Adds listing check-ins for team members.
Adds attributes
attributes to GET /memberships
endpoint.
Adds id/membership_id to check-in JSON.
Adds DELETE '/memberships/:id/check_ins/current' for checking out. Adds POST check_in_tokens
for adding tokens.
The check_ins
endpoint no more returns 409 when using a token that is already registered.
Added as_of
parameter, removed canceled_after
for /memberships
endpoint. Made /invoices
endpoint accessible for members.
Added /time_passes/unused
endpoint to get unused time passes for all members as once. Added url
and used_at
to time passes.
Made /work_sessions
endpoint available for members as well.
Added created_at
to space endpoints.
Removed authentication from list/show plans endpoints. Added canceled_after
to memberships endpoint.
Changed the quantity of invoice items from integer to decimal returned as string. What was {"quantity": 1} is now {"quantity": "1.0"}.
Added canceled_membership
event to webhooks API.
Added /answers
endpoint.
Added /booking_credits
enpoints.
Added user ids to memberships.
Added email to spaces. At the moment this uses the email of the user who created the space.
Added picture
to memberships. Removed it from users embedded in memberships.
Added /memberships/cancellations
endpoint. Added /activities
endpoint.
Removed plan terms, payment method instructions and internal memo from /memberships
endpoint.
Added CORS headers to all API calls so it can be used directly from browsers.
Added valid_from/valid_until to /work_sessions
endpoint.
Added from/to parameters to /invoices
endpoint.
Added space name to /user
endpoint. Added read_user
scope for getting the current user's details.
Added /api/check_in_tokens
endpoints. Added the ability for members to use the /api/check_ins
endpoint.
Removed /api/spaces
endpoint.
Added /api/membership/bookings/recent
endpoint.
/api/memberships
does not return canceled memberships anymore.
Added capacity
to resources.
Replaced {"membership_id": "<id>"}
in bookings with {"membership": {"id": "<id>", "name": "<name>"}}
. membership_id
is still there but removed from the documentation and will be removed from the API on or after 2013-01-01.
Replaced {"resource_name": "<name>"}
in bookings with {"resource": {"id": "<id>", "name": "<name>"}}
. resource_name
is still there but removed from the documentation and will be removed from the API on or after 2013-01-01.
Added id
to bookings and resources.
Memberships now have next_invoice_at
and upcoming_plan
.
Bookings now have a tax_rate
field. The tax rate is returned as a String, e.g. 19.5
.
Invoices now have a tax_amounts
hash instead of just one tax_amount
. The new hash looks like {<tax_rate>: <amount>}
, e.g. {"19.0": "200.0"}
.
Invoice items now have a tax rate. If the tax rate is not set in the item the invoice\'s tax rate applies.
This is to support countries that have multiple VAT rates.
The old tax_amount
attribute will be removed on or after 2012-10-01.