Sign in
billing

Create Monthly Switch Portal

Switch an annual Team subscription to monthly.

Paid annual subscribers get Stripe's confirmation UI: the server does not mutate the subscription; Stripe shows the exact unused-time credit and applies the update only after the customer explicitly confirms it.

TRIALING annual subscribers (deal-link 30-day opt-out window) are switched directly with trial_end="now": monthly has no trial by policy, so the switch ends the window and charges the first $499 immediately. The console button states the charge; error_if_incomplete keeps the subscription unchanged if the card declines.

post/api/billing/monthly-switch-portal

Request body

deal_codestring required

Response

Successful Response

portal_urlstring required
statusstring required

Changes

Changed in 5 of the 9 revisions of this API.47

  • 64da737bcc9e13See the full diff
    • ▲

      added the pattern ^[A-Za-z0-9_-]+$ to the request property

      request-property-pattern-added

    • ○

      api operation id monthly_switch_portal_api_billing_monthly_switch_portal_post removed and replaced with create_monthly_switch_portal_api_billing_monthly_switch_portal_post

      api-operation-id-removed

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      response property portal_url list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 44d8ea826f4822See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      response property portal_url list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      api operation id create_monthly_switch_portal_api_billing_monthly_switch_portal_post removed and replaced with monthly_switch_portal_api_billing_monthly_switch_portal_post

      api-operation-id-removed

    • ○

      removed the pattern ^[A-Za-z0-9_-]+$ from the request property

      request-property-pattern-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d80008a9efc61See the full diff
    • ○

      endpoint added

      endpoint-added

  • 8540ec6c17781See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a2c84c9154da1See the full diff
    • ○

      endpoint added

      endpoint-added