Account

Start a package purchase

Returns a Stripe link where the account holder buys a package, or confirms a move to a larger one. Nothing is charged or changed by this call; the new allowance applies once the account holder completes the Stripe page. A smaller package is refused with 409: downgrades are made on the billing page. Send a package, or credits, or nothing to be offered the package that covers 1.5x this month's use.

post/v1/billing/checkout

Request

  • Base URL: https://api.jobspipe.dev
  • URL: https://api.jobspipe.dev/v1/billing/checkout
  • Auth: none declared

Request body

packagestring

The package to buy: builder, growth, scale, business. Wins over credits when both are sent.

creditsnumber

Monthly credits wanted; the smallest package that covers them is chosen. Above 500,000 is an Enterprise plan.

Response

A link to pay or confirm.

urlstring uri required

Where the account holder pays or confirms the change. Open it in a browser.

flow'checkout' | 'portal' required

checkout: a Stripe Checkout page for a new subscription. portal: a Stripe page where the account holder confirms the move to the larger package.

packagestring required
creditsinteger required

Credits a month on the chosen package.

billing_interval'month' | 'year' required

How the package is billed: the account's current interval (a yearly subscriber stays yearly; credits still refresh every month). New purchases here are monthly; yearly is chosen on the billing page.

price_usdnumber required

The package's price in USD per billing_interval.

Changes

No recorded changes to this operation across all 1 revision of this API.