Sign in
plans

Retry custom plan billing

put/custom-plan-billings/{custom_plan_billing_id}/retry

Path parameters

custom_plan_billing_idstring required

custom_plan_billing_id

Request body

activation_strategy'on_payment' | 'on_publish'
billing_cycle_anchorstring date-time nullable

The date the subscription's billing period renews on. Only honored when the retry creates a subscription.

customer_emailstring required
days_until_dueinteger nullable
prorate_first_periodboolean nullable

When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.

send_invoiceboolean nullable

Whether Stripe emails the invoice when it is finalized. Defaults to true.

Response

OK

paramsobject required

Input parameters

Changes

Changed in 6 of the 128 revisions of this API.18

  • 05da7dce1cf93See the full diff
    • ○

      added the new optional request property billing_cycle_anchor

      new-optional-request-property

    • ○

      added the new optional request property prorate_first_period

      new-optional-request-property

    • ○

      added the optional property data/prorate_first_period to the response with the 200 status

      response-optional-property-added

  • 776228e28d671See the full diff
    • ○

      added the optional property data/billing_cycle_anchor to the response with the 200 status

      response-optional-property-added

  • 4a9d0e476c081See the full diff
    • ○

      added the required property data/plan_billing_source to the response with the 200 status

      response-required-property-added

  • 1f5b7fcc3c652See the full diff
    • ○

      added the new optional request property send_invoice

      new-optional-request-property

    • ○

      added the required property data/send_invoice to the response with the 200 status

      response-required-property-added

  • 96d06fa89a731See the full diff
    • ●

      removed the request property pay_in_advance

      request-property-removed

  • 110f1d3153f91See the full diff
    • ○

      added the optional property data/external_invoice_id to the response with the 200 status

      response-optional-property-added