Plans

Buy 30 days of a plan from the balance

CHARGES THE BALANCE the tier price for 30 days that never renew (starts now, or queues behind the running period). maxCents caps the charge (409 price_changed). requestId is required: a retry with it returns the same period, never a second charge. Refused while a card plan is active.

post/v1/account/plan/balance

Request

  • Base URL: https://api.pmwallets.com
  • URL: https://api.pmwallets.com/v1/account/plan/balance
  • Auth: API key in header x-api-key

Request body

tier'base' | 'pro' | 'max' required

Base 499, Pro 1499, Max 3999 cents per 30 days.

maxCentsinteger required

Most you agree to be charged, in cents.

requestIdstring required

Your idempotency key for this purchase; reuse it on retry, use a new one for a new purchase.

Response

Bought (HTTP 201); the body also carries the updated plan status.

outcome'started' | 'queued' | 'replayed'
startsAtstring
endsAtstring
centsinteger
trialobject

Changes

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