curl --request POST \
--url https://api.yorlet.com/v1/subscription_items/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"price_data": {
"amount": 123,
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"proration_behavior": "create_prorations",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>"
}
'{
"id": "<string>",
"created": 123,
"object": "subscription_item",
"description": "<string>",
"price": "<string>",
"price_data": {
"amount": 123,
"currency": "gbp",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"tax_percent": 123,
"type": "recurring"
},
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"subscription": "<string>",
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>",
"type": "charge",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"metadata": {}
}Update a subscription item
curl --request POST \
--url https://api.yorlet.com/v1/subscription_items/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"price_data": {
"amount": 123,
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"proration_behavior": "create_prorations",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>"
}
'{
"id": "<string>",
"created": 123,
"object": "subscription_item",
"description": "<string>",
"price": "<string>",
"price_data": {
"amount": 123,
"currency": "gbp",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"tax_percent": 123,
"type": "recurring"
},
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"subscription": "<string>",
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>",
"type": "charge",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"metadata": {}
}API Key authentication. Use "Bearer YOUR_API_KEY".
The id identifier.
The price data for the subscription item.
Show child attributes
The description of the subscription item.
Set of key-value pairs to attach to the subscription item.
Show child attributes
Whether to create prorations when updating the subscription item.
create_prorations, none The schedule for the subscription item.
Show child attributes
The identifier of the tax rate for the subscription item.
The transfer behavior for the subscription item.
automatic, owner, none The identifier of the connected account to transfer funds to.
Update a subscription item
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
subscription_item The description of the subscription item.
The identifier of the price for the subscription item.
^[a-zA-Z0-9_]+$The price data for the subscription item.
Show child attributes
The schedule for the subscription item.
Show child attributes
The identifier of the subscription the item belongs to.
^[a-zA-Z0-9_]+$The identifier of the tax rate for the subscription item.
^[a-zA-Z0-9_]+$The transfer behavior for the subscription item.
automatic, owner, none, null The identifier of the connected account to transfer funds to.
^[a-zA-Z0-9_]+$The type of the subscription item.
charge, rent, product The identifier of the unit associated with the subscription item.
^[a-zA-Z0-9_]+$The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Set of key-value pairs attached to the subscription item.
Show child attributes
Was this page helpful?