Update subscription
Update a subscription by ID.
Path Parameters
org_id string required
billing_id string required
ID of the billing account to update the subscription for
id string required
ID of the subscription to update
application/json
Request Body required
metadata object
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
subscription object
{
"subscription": {
"id": "string",
"customer_id": "string",
"provider_id": "string",
"plan_id": "string",
"state": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.248Z",
"updated_at": "2024-07-13T09:54:48.248Z",
"canceled_at": "2024-07-13T09:54:48.248Z",
"ended_at": "2024-07-13T09:54:48.248Z",
"trial_ends_at": "2024-07-13T09:54:48.248Z",
"current_period_start_at": "2024-07-13T09:54:48.248Z",
"current_period_end_at": "2024-07-13T09:54:48.248Z",
"billing_cycle_anchor_at": "2024-07-13T09:54:48.248Z",
"phases": [
{
"effective_at": "2024-07-13T09:54:48.248Z",
"plan_id": "string"
}
],
"customer": {
"id": "string",
"org_id": "string",
"name": "string",
"email": "string",
"phone": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"provider_id": "string",
"provider": "string",
"currency": "string",
"state": "string",
"tax_data": [
{
"type": "string",
"id": "string"
}
],
"metadata": {},
"created_at": "2024-07-13T09:54:48.248Z",
"updated_at": "2024-07-13T09:54:48.248Z",
"organization": {
"id": "string",
"name": "string",
"title": "string",
"metadata": {},
"created_at": "2023-06-07T05:39:56.961Z",
"updated_at": "2023-06-07T05:39:56.961Z",
"state": "enabled",
"avatar": "string"
}
},
"plan": {
"id": "string",
"name": "string",
"title": "string",
"description": "string",
"products": [
{
"id": "string",
"name": "string",
"title": "string",
"description": "string",
"plan_ids": [
"string"
],
"state": "string",
"prices": [
{
"id": "string",
"product_id": "string",
"provider_id": "string",
"name": "string",
"interval": "string",
"usage_type": "string",
"billing_scheme": "string",
"state": "string",
"currency": "string",
"amount": "string",
"metered_aggregate": "string",
"tier_mode": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.248Z",
"updated_at": "2024-07-13T09:54:48.248Z"
}
],
"behavior": "string",
"features": [
{
"id": "string",
"name": "string",
"product_ids": [
"string"
],
"title": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.248Z",
"updated_at": "2024-07-13T09:54:48.248Z"
}
],
"behavior_config": {
"credit_amount": "string",
"seat_limit": "string",
"min_quantity": "string",
"max_quantity": "string"
},
"metadata": {},
"created_at": "2024-07-13T09:54:48.248Z",
"updated_at": "2024-07-13T09:54:48.248Z"
}
],
"interval": "string",
"on_start_credits": "string",
"trial_days": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.248Z",
"updated_at": "2024-07-13T09:54:48.248Z"
}
}
}
Bad Request - The request was malformed or contained invalid parameters.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
PUT /v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id
Authorization
name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic
Request
Request
curl / cURL
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
python / requests
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
go / native
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
nodejs / axios
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
ruby / Net::HTTP
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
csharp / RestSharp
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
php / cURL
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
java / OkHttp
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'
powershell / RestMethod
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {}
}'