Platform: give complimentary plan access until a date or with no end date (no Stripe write)

post/api/v1/platform/businesses/{id}/billing-controls/complimentary

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/platform/businesses/{id}/billing-controls/complimentary
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

idstring required

Request body

reasonstring required
if_versioninteger required
idempotency_keystring required
plan_id'solo' | 'team' | 'multi_site' required
untilstring

YYYY-MM-DD or an ISO date-time

indefiniteboolean

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.