Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Subscription Renewals

List Scheduled Renewals

GET
/subscriptions/{subscription_id}/scheduled_renewals.json

Lists scheduled renewal configurations for the subscription and permits an optional status query filter.

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.

Query Parameters

status?string

(Optional) Status filter for scheduled renewal configurations.

Value in

  • "draft"
  • "scheduled"
  • "pending"
  • "canceled"
  • "active"
  • "fulfilled"

Response Body

application/json

curl -X GET "https://example.com/subscriptions/0/scheduled_renewals.json"
{  "scheduled_renewal_configurations": [    {      "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",          "name": "Register",          "currency_code": "USD"        }      }    }  ]}

Preview Subscription Product Migration POST

Previews the charges resulting from migrating a subscription to a different product. ## Previewing a future date It is also possible to preview the migration for a date in the future, as long as it's still within the subscription's current billing period, by passing a `proration_date` along with the request (e.g., `"proration_date": "2020-12-18T18:25:43.511Z"`). This will calculate the prorated adjustment, charge, payment and credit applied values assuming the migration is done at that date in the future as opposed to right now.

Create Scheduled Renewal POST

Creates a scheduled renewal configuration for a subscription. The scheduled renewal is based on the subscription’s current product and component setup.