Sign in
billing

Grace recovery: attach a new payment instrument and collect the outstanding balance

Changed on

GET /billing/subscription/, POST .../change-plan/, POST .../cancel/, POST .../retry-payment/.

post/billing/subscription/retry-payment{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Request body

idempotency_keystring required
payment_tokenstring required

Response

The new instrument was attached and the outstanding balance was submitted for collection at the provider. Recovery is webhook-driven -- the subscription in this response is still "grace"/"restricted"; it moves to "active" only once the subscription-payment webhook confirms the charge.

idinteger required
billing_state'free' | 'active' | 'grace' | 'restricted' | 'cancelled' required
  • free - Free
  • active - Active
  • grace - Grace period
  • restricted - Restricted
  • cancelled - Cancelled
billing_interval'monthly' | 'annual' required
  • monthly - Monthly
  • annual - Annual
payment_provider'mercadopago' | 'stripe' required
  • mercadopago - MercadoPago
  • stripe - Stripe
current_period_startstring date-time required
current_period_endstring date-time required
grace_period_ends_atstring date-time nullable required
pending_plan_slugstring required
pending_billing_interval'monthly' | 'annual' required
  • monthly - Monthly
  • annual - Annual
pending_plan_effective_atstring date-time nullable required

Changes

  • f3e96ee789afRevision changes
    • ▲

      removed the required property ///// from the response with the status

    • ○

      added the required property ///// to the response with the status

  • e92afcb6b029Revision changes
    • ●

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

    • ●

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

    • ○

      removed the calendar_groups enum value from the ////// response property for the response status

    • ○

      removed the calendar_groups enum value from the /////////// response property for the response status