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": "<string>",
  "product": {},
  "customer": {},
  "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_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

​
x-api-key
string
required

Path Parameters

​
id
string
required

Body

application/json
​
items
object[]

List of subscription items to update/create. If no item ID is provided, the item will be created.

​
update_behavior
enum<string>
default:proration-charge

The update behavior for the subscription (defaults to proration)

Available options:
proration-charge-immediately,
proration-charge,
proration-none

Response

200 - application/json
Successfully update a subscription
​
id
string
required

Unique identifier for the object.

​
mode
enum<string>
required

String representing the environment.

Available options:
test,
live,
sandbox
​
object
string
required

String representing the object’s type. Objects of the same type share the same value.

​
product
object
required

The product associated with the subscription.

​
customer
object
required

The customer who owns the subscription.

​
collection_method
string
required

The method used for collecting payments for the subscription.

Example:

"charge_automatically"

​
status
enum<string>
required

The current status of the subscription.

Available options:
active,
canceled,
unpaid,
paused,
trialing
Example:

"active"

​
created_at
string
required

The date and time when the subscription was created.

Example:

"2024-01-01T00:00:00Z"

​
updated_at
string
required

The date and time when the subscription was last updated.

Example:

"2024-09-12T12:34:56Z"

​
items
object[]

Subscription items.

​
last_transaction_id
string

The ID of the last paid transaction.

Example:

"tran_3e6Z6TzvHKdsjEgXnGDEp0"

​
last_transaction_date
string

The date of the last paid transaction.

Example:

"2024-09-12T12:34:56Z"

​
next_transaction_date
string

The date when the next subscription transaction will be charged.

Example:

"2024-09-12T12:34:56Z"

​
current_period_start_date
string

The start date of the current subscription period.

Example:

"2024-09-12T12:34:56Z"

​
current_period_end_date
string

The end date of the current subscription period.

Example:

"2024-09-12T12:34:56Z"

​
canceled_at
string

The date and time when the subscription was canceled, if applicable.

Example:

"2024-09-12T12:34:56Z"