v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Billing Schedules

Create billing schedule payment settings

Create payment settings for billing schedules. Invoices for billing schedules with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Billing schedule payment settings override customer payment settings. You can also override billing schedule payment settings with invoice payment settings.

post/payments/settings/billing-schedules

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Request body

billingScheduleIdstring required

Unique payment provider ID.

paymentProvider'STRIPE' | 'GOCARDLESS' | 'NONE' required

autoChargeboolean nullable

Automatically collect this payment if payment details are available

Example request

{
  "billingScheduleId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "paymentProvider": "STRIPE",
  "autoCharge": true
}

Response

Created

idstring required

Unique payment provider ID.

sequenceAccountIdstring required

Unique Sequence Account ID.

billingScheduleIdstring required

Unique payment provider ID.

paymentProvider'STRIPE' | 'GOCARDLESS' | 'NONE' required

autoChargeboolean required

Automatically collect payments if payment details are available

Example response

{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "sequenceAccountId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "billingScheduleId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "paymentProvider": "STRIPE",
  "autoCharge": true
}