ENentire
Me

Set up billing for the caller

Changed on

Opens Stripe Checkout to save a card, with nothing charged. The success and cancel URLs must be https URLs on entire.io or partial.to, and the success URL must include the literal {CHECKOUT_SESSION_ID}. A 409 means billing is already set up.

post/api/v1/me/billing/setup

Request

  • Base URL
    https://entire.io (the document declares no server; this is the origin it was published from)
  • URL
    https://entire.io/api/v1/me/billing/setup
  • Auth
    none declared

Request body

success_urlstring required
cancel_urlstring required

Response

The billing state. checkout_url is where the caller saves a card; billing is set up after the return, through the complete route.

state'not_started' | 'pending_card' | 'provisioning' | 'active' required
currencystring
unavailablestring[]

Sections that could not be read now and are omitted. Read again later.

checkout_urlstring

Stripe Checkout that saves a card. Absent when no Checkout is needed.

Changes

  • a78c48de157dRevision changes
    • warning

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

  • f4a534501f84Revision changes
    • warning

      removed the optional property from the response with the status

    • info

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