Subscription
Update Subscription
Subscription
Update Subscription
POST
/
v1
/
subscriptions
/
{id}
curl --request POST \
--url https://api.creem.io/v1/subscriptions/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{
"items": [
{
"id": "<string>",
"product_id": "<string>",
"price_id": "<string>",
"units": 123
}
],
"update_behavior": "proration-charge"
}'
{
"id": "<string>",
"mode": "test",
"object": "subscription",
"product": {
"id": "<string>",
"mode": "test",
"object": "<string>",
"name": "<string>",
"description": "This is a sample product description.",
"image_url": "https://example.com/image.jpg",
"features": [
{
"id": "<string>",
"type": "<string>",
"description": "Get access to discord server."
}
],
"price": 400,
"currency": "EUR",
"billing_type": "recurring",
"billing_period": "every-month",
"status": "<string>",
"tax_mode": "inclusive",
"tax_category": "saas",
"product_url": "https://creem.io/product/prod_123123123123",
"default_success_url": "https://example.com/?status=successful",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
},
"customer": {
"id": "<string>",
"mode": "test",
"object": "<string>",
"email": "user@example.com",
"name": "John Doe",
"country": "US",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
},
"items": [
{
"id": "<string>",
"mode": "test",
"object": "<string>",
"product_id": "<string>",
"price_id": "<string>",
"units": 123
}
],
"collection_method": "charge_automatically",
"status": "active",
"last_transaction_id": "tran_3e6Z6TzvHKdsjEgXnGDEp0",
"last_transaction": {
"id": "<string>",
"mode": "test",
"object": "transaction",
"amount": 2000,
"amount_paid": 2000,
"discount_amount": 2000,
"currency": "EUR",
"type": "<string>",
"tax_country": "US",
"tax_amount": 2000,
"status": "<string>",
"refunded_amount": 2000,
"order": "<string>",
"subscription": "<string>",
"customer": "<string>",
"description": "<string>",
"period_start": 123,
"period_end": 123,
"created_at": 123
},
"last_transaction_date": "2024-09-12T12:34:56Z",
"next_transaction_date": "2024-09-12T12:34:56Z",
"current_period_start_date": "2024-09-12T12:34:56Z",
"current_period_end_date": "2024-09-12T12:34:56Z",
"canceled_at": "2024-09-12T12:34:56Z",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-09-12T12:34:56Z"
}
Headers
Path Parameters
Body
application/json
Response
200 - application/json
Successfully update a subscription
The response is of type object
.
curl --request POST \
--url https://api.creem.io/v1/subscriptions/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{
"items": [
{
"id": "<string>",
"product_id": "<string>",
"price_id": "<string>",
"units": 123
}
],
"update_behavior": "proration-charge"
}'
{
"id": "<string>",
"mode": "test",
"object": "subscription",
"product": {
"id": "<string>",
"mode": "test",
"object": "<string>",
"name": "<string>",
"description": "This is a sample product description.",
"image_url": "https://example.com/image.jpg",
"features": [
{
"id": "<string>",
"type": "<string>",
"description": "Get access to discord server."
}
],
"price": 400,
"currency": "EUR",
"billing_type": "recurring",
"billing_period": "every-month",
"status": "<string>",
"tax_mode": "inclusive",
"tax_category": "saas",
"product_url": "https://creem.io/product/prod_123123123123",
"default_success_url": "https://example.com/?status=successful",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
},
"customer": {
"id": "<string>",
"mode": "test",
"object": "<string>",
"email": "user@example.com",
"name": "John Doe",
"country": "US",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
},
"items": [
{
"id": "<string>",
"mode": "test",
"object": "<string>",
"product_id": "<string>",
"price_id": "<string>",
"units": 123
}
],
"collection_method": "charge_automatically",
"status": "active",
"last_transaction_id": "tran_3e6Z6TzvHKdsjEgXnGDEp0",
"last_transaction": {
"id": "<string>",
"mode": "test",
"object": "transaction",
"amount": 2000,
"amount_paid": 2000,
"discount_amount": 2000,
"currency": "EUR",
"type": "<string>",
"tax_country": "US",
"tax_amount": 2000,
"status": "<string>",
"refunded_amount": 2000,
"order": "<string>",
"subscription": "<string>",
"customer": "<string>",
"description": "<string>",
"period_start": 123,
"period_end": 123,
"created_at": 123
},
"last_transaction_date": "2024-09-12T12:34:56Z",
"next_transaction_date": "2024-09-12T12:34:56Z",
"current_period_start_date": "2024-09-12T12:34:56Z",
"current_period_end_date": "2024-09-12T12:34:56Z",
"canceled_at": "2024-09-12T12:34:56Z",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-09-12T12:34:56Z"
}