Skip to main content

​
Version: 2024-07-30

​
Billing

​
Collections

​
Customers

  • REMOVED Delete customer endpoint
  • UPDATED Archive customer endpoint
    • HTTP method updated from PUT to POST
    • Added field organizations
    • Removed contactName, email and billingEmails fields in favour of contacts
    • Removed field telephone
    • Removed field deletedAt
    • Addition: status to request and response
  • UPDATED Create customer endpoint
    • Added optional parentId field to request
    • Added field organizations to response
    • Removed contactName, email and billingEmails fields in favour of contacts in request and response
    • Removed field telephone from request and response
    • Removed field deletedAt from response
    • Addition: status to request and response
  • UPDATED Update customer endpoint
    • Added optional parentId field to request
    • Added field organizations to response
    • Removed contactName, email and billingEmails fields in favour of contacts in request and response
    • Removed field telephone from request and response
    • Removed field deletedAt from response
    • Addition: status to request and response
  • UPDATED List customers endpoint
    • Added field organizations
    • Removed contactName, email and billingEmails fields
    • Removed field telephone
    • Removed field deletedAt
  • UPDATED Get customer endpoint
    • Added field organizations
    • Removed contactName, email and billingEmails fields in favour of contacts
    • Removed field telephone
    • Removed field deletedAt
    • Addition: status to request and response
  • NEW Create customer organization endpoint
  • NEW Add customer organization member endpoint
  • NEW Replace customer organization members endpoint

​
Invoices

​
Products

​
Quotes

​
Taxes

​
Version: 2024-05-09

Naming improvements and simplifications across billing, customers, products, taxes and usage APIs. Further details below.

​
Billing

  • Removed POST /discounts endpoint.
  • Renamed externalIds to integrationIds in Price requests and updated model to be {service: string, id: string}.
  • Renamed externalIds to integrationIds in Price responses and updated model to be {service: string, id: string, lastSynced: timestamp}.
  • Removed sequenceAccountId and deletedAt from list Price response model.
  • Removed sequenceAccountId from Price deletion response model.
  • Removed sequenceAccountId from Price creation response model.
  • Renamed parameters to customMetricParameters in Price request and response models.
  • Updated the following fields on seat-based pricing structure:
    • Renamed seatTypeId to seatMetricId
    • Removed values USE_FIRST and PRORATE_ALL_CHANGES from prorationStrategy
    • Renamed includedSeats to contractedMinimumSeats
    • Removed chargeMethod
  • Updated the following fields on the Billing Schedule models:
    • Removed type from request and response models
    • Removed discounts from Billing Schedule creation request - these should now be provided as part of a Phase
    • Renamed createAsDraft to isDraft on creation request
    • Renamed collectionPaymentProvider to paymentProvider on creation request
    • Removed sequenceAccountId from response model
    • Removed priceIds from response model

​
Collections

  • Updated the following URLs
    • POST /billing-schedule-settings -> POST /payments/settings/billing-schedules
    • GET /billing-schedule-settings/for-billing-schedule/{id} -> GET /payments/settings/billing-schedules/for-billing-schedule/{id}
    • GET /billing-schedule-settings/{id} -> GET /payments/settings/billing-schedules/{id}
    • PUT /billing-schedule-settings/{id} -> PUT /payments/settings/billing-schedules/{id}
    • DELETE /billing-schedule-settings/{id} -> DELETE /payments/settings/billing-schedules/{id}
    • POST /invoice-settings -> POST /payments/settings/invoices
    • GET /invoice-settings/for-invoice/{id} -> GET /payments/settings/invoices/for-invoice/{id}
    • GET /invoice-settings/{id} -> GET /payments/settings/invoices/{id}
    • PUT /invoice-settings/{id} -> PUT /payments/settings/invoices/{id}
    • DELETE /invoice-settings/{id} -> DELETE /payments/settings/invoices/{id}
    • POST /customer-settings -> POST /payments/settings/customers
    • GET /customer-settings/{id} -> GET /payments/settings/customers/{id}
    • PUT /customer-settings/{id} -> PUT /payments/settings/customers/{id}
    • DELETE /customer-settings/{id} -> DELETE /payments/settings/customers/{id}

​
Customers

  • Renamed externalIds to integrationIds in Customer requests and updated model to be {service: string, id: string}.
  • Renamed externalIds to integrationIds in Customer responses and updated model to be {service: string, id: string, lastSynced: timestamp}.

​
Products

  • Removed sequenceAccountId from Product request and response models.

​
Taxes

  • Removed subRates from Tax Rate request and response models.
  • Removed sequenceAccountId from Tax Rate response models.

​
Usage

  • Renamed Seat Types to Seat Metrics and updated URLs to be /seat-metrics.
  • Removed sequenceAccountId from Seat Metric response model.
  • Renamed sequenceUserId to createdBy on Seat Metric response model and removed it from request model.
  • Renamed key to seatType on Seat Metric request and response models.
  • Renamed Seat Snapshots to Seat Events and updated URLs to be /seat-events.
  • Removed seatChanges from Seat Event request and response models.

​
Version: 2024-01-01

Initial release of the versioned Sequence REST API.
⌘I