Subscribe a customer to an offer (write)
create_subscriptionCreate a subscription linking an existing customer to an offer, with optional immediate activation and billing.
Instructions
WRITE. Creates a ProAbono subscription linking an existing customer to an offer. This is the API path; a customer choosing a plan themselves goes through a hosted subscription workflow instead. The subscription is created as a copy of the offer -- pass an override only where the merchant genuinely departs from their own catalogue. Set start_now to activate it immediately; a subscription left in Draft grants no rights. A draft one is activated later with start_subscription.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"customer_ref": "<customer_ref>",
"offer_ref": "<offer_ref>"
},
"name": "create_subscription"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bill_now | No | Trigger billing immediately after starting. | |
| metadata | No | Free key/value pairs stored on the record. At most 5 keys, 450 characters per value. | |
| offer_ref | Yes | Shared reference of the offer to subscribe to. | |
| start_now | No | Attempt to start the subscription immediately after creation. | |
| customer_ref | Yes | Shared reference of the customer who receives it. | |
| ensure_billable | No | Check the customer can be billed before creating the subscription. | |
| buyer_customer_ref | No | Shared reference of the customer who pays, when it is not the recipient. |