Sign in

v356

OpenAPI 3.0.3raw.githubusercontent.com2026-08-031733562.1 MB
Billing Schedules

Get billing schedule payment settings by billing schedule ID

Get payment settings for billing schedules by billing schedule ID. 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.

get/payments/settings/billing-schedules/for-billing-schedule/{id}

Path parameters

idstring required

Unique billing schedule ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

OK

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
}