Subscription Renewals
Create Scheduled Renewal
Creates a scheduled renewal configuration for a subscription. The scheduled renewal is based on the subscription’s current product and component setup.
Authorization
BasicAuth AuthorizationBasic <token>
The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
subscription_id*integer
The Chargify id of the subscription.
Request Body
application/json
renewal_configuration*
Response Body
application/json
application/json
curl -X POST "https://example.com/subscriptions/0/scheduled_renewals.json" \ -H "Content-Type: application/json" \ -d '{ "renewal_configuration": { "starts_at": "2024-12-01T00:00:00Z", "ends_at": "2025-12-01T00:00:00Z", "lock_in_at": "2024-11-15T00:00:00Z", "contract_id": 222 } }'{ "scheduled_renewal_configuration": { "id": 123, "site_id": 456, "subscription_id": 12345, "starts_at": "2024-12-01T00:00:00Z", "ends_at": "2025-12-01T00:00:00Z", "lock_in_at": "2024-11-15T00:00:00Z", "created_at": "2024-09-01T12:00:00Z", "status": "scheduled", "scheduled_renewal_configuration_items": [ { "id": 789, "subscription_id": 12345, "subscription_renewal_configuration_id": 123, "item_id": 4, "item_type": "Product", "item_subclass": "Product", "price_point_id": 7, "price_point_type": "ProductPricePoint", "quantity": 1, "decimal_quantity": "1.0", "created_at": "2024-09-01T12:00:00Z" } ], "contract": { "id": 107, "maxio_id": "maxio-id", "number": null, "register": { "id": 12, "maxio_id": "maxio_id-id", "name": "Register", "currency_code": "USD" } } }}