Subscription Item Errors
The following error codes and messages appear in REST responses when an error prevents completion of the request.
Error Code | Description |
|---|---|
ERROR_CREATE_SUBSCRIPTION_ITEM | The request attempted an operation that requires a plan ID, but the value was missing or was not recognized. The request was rejected. Corrective action: Provide a valid plan ID. |
ERROR_CURRENCY_OR_INTERVAL_MISMATCH | The request tried to add or update the list of subscription items in a subscription, but the plans in the subscription items did not all have the same values for 'currency' and 'interval'. The request was rejected. Corrective action: Include only plans that all have the same values for 'currency' and 'interval'. |
ERROR_DELETE_LAST_SUBSCRIPTION_ITEM | The request tried to delete a subscription item from a subscription, but the subscription item is the only one in the subscription. The request was rejected. Corrective action: Delete the subscription. |
ERROR_GET_SUBSCRIPTION_ITEM | The request tried to retrieve a subscription item, but the subscription item was not found. The request was rejected. Corrective action: Use a valid subscription item ID. |
ERROR_PRORATION_DATE_NOT_VALID | The request attempted to set a proration date on a subscription item, but the date selected was not valid. The request was rejected. Corrective action: For ‘proration_date’, use a date within the current billing period. |
ERROR_UPDATE_SUBSCRIPTION_ITEM_USAGE_TYPE | The request tried to update a subscription item, but the usage type in the new plan did not match the usage type in the old plan. The request was rejected. Corrective action: Choose a plan that has the same 'usage_type'. |
INVALID_PRORATE_VALUE | The request tried to set a proration date on a subscription item, but the value of 'prorate' was not valid. The request was rejected. Corrective action: Set 'prorate' to true. |
INVALID_SUBSCRIPTION_ITEM_PRORATE | The request tried to create or update a subscription item, but the setting for the 'prorate' body parameter was not a Boolean. The request was rejected. Corrective action: Select a Boolean value for the 'prorate' parameter. |
INVALID_SUBSCRIPTION_ITEM_PRORATION_DATE | The request attempted to set a proration date on a subscription item, but the date selected was not valid. The request was rejected. Corrective action: For 'proration_date', use a Unix timestamp within the current billing period. |
INVALID_SUBSCRIPTION_ITEM_QUANTITY | The request tried to create a usage record for a subscription item, but the quantity was not valid or 'usage_type' in the relevant plan was set to 'metered'. The request was rejected. Corrective action: Use a positive integer for 'quantity' or create a new subscription item with a plan that has 'usage_type' set to 'metered'. |
INVALID_SUBSCRIPTION_ITEM_USAGE_RECORD_TIMESTAMP | The request tried to create a usage record, but the value for the 'timestamp' body parameter was not in the correct format. The request was rejected. Corrective action: Use a valid Unix timestamp. |