plans

Retry custom plan billing

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

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/custom-plan-billings/{custom_plan_billing_id}/retry
  • Auth
    API key in header X-Schematic-Api-Key

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.

billing_start_datestring date-time nullable

The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. When both are omitted, the term pinned at finalize is reissued. Only honored when the retry creates a subscription.

customer_emailstring required
days_until_dueinteger nullable
end_datestring date-time nullable

When a plan that doesn't renew ends. Moved back to the last renewal on or before it. When omitted, the end date set at finalize is reissued. Only honored when the retry creates a subscription.

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

  • 6d4b96940aadRevision changes
    • info

      added the optional property / to the response with the status

  • ce7c5cc627adRevision changes
    • warning

      added the new end_date_must_be_future enum value to the /// response property for the response status

    • warning

      added the new end_date_needs_new_subscription enum value to the /// response property for the response status

    • warning

      added the new end_date_not_after_renewal_date enum value to the /// response property for the response status

    • info

      added the new optional request property