POST
/
payments
/
settings
/
billing-schedules
Create billing schedule payment settings
curl --request POST \
  --url https://eu.sequencehq.com/api/payments/settings/billing-schedules \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "billingScheduleId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "paymentProvider": "STRIPE",
  "autoCharge": true
}'
{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "sequenceAccountId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "billingScheduleId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "paymentProvider": "STRIPE",
  "autoCharge": true
}

Headers

​
Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

​
Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Body

application/json
​
billingScheduleId
string
required

Unique payment provider ID.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

​
paymentProvider
enum<string>
required

Payment provider

Available options:
STRIPE,
NONE
Example:

"STRIPE"

​
autoCharge
boolean

Automatically collect this payment if payment details are available

Example:

true

Response

Created

​
id
string
required

Unique payment provider ID.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

​
sequenceAccountId
string
required

Unique Sequence Account ID.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

​
billingScheduleId
string
required

Unique payment provider ID.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

​
paymentProvider
enum<string>
required

Payment provider

Available options:
STRIPE,
NONE
Example:

"STRIPE"

​
autoCharge
boolean
required

Automatically collect payments if payment details are available

Example:

true