The Subscription Schedule
details when the Fee
is charged to the Merchant
.
Related Guides: Subscription Billing
Retrieve the details of a subscription_schedule
Example response
Authentication information is missing or invalid
Forbidden
Not Found
Not Acceptable
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV" \ -H "Finix-Version: 2022-02-01" \ -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
{- "id": "SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV",
- "created_at": "2022-08-01T17:53:54.63Z",
- "updated_at": "2022-08-01T17:53:54.63Z",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fixed_time_interval_offset": {
- "hourly_interval": 24,
- "interval_count": 4
}, - "line_item_type": "FEE",
- "nickname": "Fixed_Time_Subscription_Schedule",
- "period_offset": null,
- "subscription_type": "FIXED_TIME_INTERVAL",
- "tags": { },
}
Update the details of a subscription_schedule
.
object or null Include up to 50
(e.g., |
Example response
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV" \ -H "Content-Type: application/json" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \ -X PUT \ -d ' { "tags": { "order-reference": "A1B2C3D4E5" } }'
{- "id": "SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV",
- "created_at": "2022-08-01T17:53:54.63Z",
- "updated_at": "2022-08-01T17:53:54.63Z",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fixed_time_interval_offset": {
- "hourly_interval": 24,
- "interval_count": 4
}, - "line_item_type": "FEE",
- "nickname": "Fixed_Time_Subscription_Schedule",
- "period_offset": null,
- "subscription_type": "FIXED_TIME_INTERVAL",
- "tags": { },
}
Retrieve a list of Subscription Schedules
.
List of subscription_schedule objects
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/" \ -H "Finix-Version: 2022-02-01" \ -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
{- "_embedded": {
- "subscription_schedules": [
- {
- "id": "SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N",
- "created_at": "2022-08-17T04:54:00.31Z",
- "updated_at": "2022-08-17T04:54:00.31Z",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fixed_time_interval_offset": {
- "hourly_interval": 24,
- "interval_count": 4
}, - "line_item_type": "FEE",
- "nickname": "Fixed_Time_Subscription_Schedule",
- "period_offset": null,
- "subscription_type": "FIXED_TIME_INTERVAL",
- "tags": { },
}, - {
- "id": "SUBSCHEDULE_rhbHGjhydMxsEXw4otBCFz",
- "created_at": "2022-07-11T18:39:30.21Z",
- "updated_at": "2022-07-11T18:39:30.21Z",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fixed_time_interval_offset": {
- "hourly_interval": 24,
- "interval_count": 4
}, - "line_item_type": "FEE",
- "nickname": "Fixed_Time_Subscription_Schedule",
- "period_offset": null,
- "subscription_type": "FIXED_TIME_INTERVAL",
- "tags": { },
}
]
}, - "_links": {
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 2
}
}
Create a subscription_schedule
.
Accept | string Default: application/hal+json |
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
Example response
Unauthorized
Forbidden
Object does not exist
Not Acceptable
{- "id": "SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV",
- "created_at": "2022-08-01T17:53:54.63Z",
- "updated_at": "2022-08-01T17:53:54.63Z",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fixed_time_interval_offset": {
- "hourly_interval": 24,
- "interval_count": 4
}, - "line_item_type": "FEE",
- "nickname": "Fixed_Time_Subscription_Schedule",
- "period_offset": null,
- "subscription_type": "FIXED_TIME_INTERVAL",
- "tags": { },
}