Stripe Collection Settings

Update Stripe collection settings for Sequence account

Changed on

Updates Stripe collection settings for the current Sequence accounts.

put/stripe/collections/settings/{id}

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/stripe/collections/settings/{id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

idstring required

Stripe Collection Settings ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

enableAutomaticPaymentsboolean

Whether to automatically collect payments by default if payment details are available

autoEnableStripePaymentsboolean

Whether to automatically enable Stripe payments for new billing schedules

retryAnchor'SENT_DATE' | 'DUE_DATE'
retryOffsetDaysinteger[]

Days after the anchor date on which to re-attempt collection, e.g. [0, 7, 14]

Example request

{
  "enableAutomaticPayments": false,
  "autoEnableStripePayments": true,
  "retryAnchor": "DUE_DATE",
  "retryOffsetDays": [
    0,
    7,
    14
  ]
}

Response

OK

idstring required
sequenceAccountIdstring required
enableAutomaticPaymentsboolean required

Whether to automatically collect payments by default if payment details are available

autoEnableStripePaymentsboolean required

Whether to automatically enable Stripe payments for new billing schedules

retryOffsetDaysinteger[] required

Days after the anchor date on which to re-attempt collection, e.g. [0, 7, 14]

Example response

{
  "id": "018f6b0c-7e89-7b4a-8e47-1b2e2d5a4f6c",
  "sequenceAccountId": "683fe518-60c8-429f-9320-8aa7efc20bcc",
  "enableAutomaticPayments": true,
  "autoEnableStripePayments": false,
  "retryOffsetDays": []
}

Changes

  • 219366f4e22dRevision changes
    • breaking

      added the new required header request parameter Authorization

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the / response's property type changed from no type to integer for status

    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version

  • c48cffa2c23dRevision changes
    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable