Справочник APIConsumerBilling
Pause_subscription
Эта страница пока доступна только на английском языке. Руководства переведены; автоматически генерируемый справочник API публикуется на английском.
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Format
uuidHeader Parameters
X-Project-Id*string
UUID of the project that scopes consumer accounts, devices, sessions, and VSpaces for the request.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
(GAP-25) Consumer self-pause body. Unlike the platform/admin PauseRequest
this carries NO project_id (the consumer's project comes from ProjectId).
Both fields are optional, so an empty {} body keeps the prior bodyless
behaviour (indefinite pause, no reason). The handler previously had no JSON
extractor at all, so until was silently dropped.
Response Body
application/json
application/json
curl -X POST "https://example.com/consumer/v1/billing/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause" \ -H "X-Project-Id: 11111111-1111-1111-1111-111111111111" \ -H "Content-Type: application/json" \ -d '{}'{ "amount_minor": 0, "billing_account_id": "db2251e5-5308-40a7-9f48-3aed5a9ce736", "cancel_at_period_end": true, "canceled_at": "2019-08-24T14:15:22Z", "currency": "string", "current_period_end": "2019-08-24T14:15:22Z", "current_period_start": "2019-08-24T14:15:22Z", "grace_period_end": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "plan_id": "00713021-9aea-41da-9a88-87760c08fa72", "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "state_reason": "new_purchase", "status": "pending", "trial_end_at": "2019-08-24T14:15:22Z", "vendor_type": "stripe"}{ "detail": "Pool slug must be unique.", "instance": "urn:forestvpn:trace:a1b2c3d4", "title": "Validation Error", "type": "https://fvpn.net/errors/validation"}