Documentation

BILLING_SCHEME_SHOULD_BE_TIERED

The request tried to create a plan, but the request contains tiers and the 'billing_scheme' body parameter is not set to 'tiered'. The request was rejected. Corrective action: Set 'billing_scheme' to 'tiered' or remove the tiers.

ERROR_CREATE_PLAN

The request tried to create a plan, but the 'type' field of a product is set to 'goods'. The request was rejected. Corrective action: Add only products that have 'type' set to 'service'.

ERROR_CREATE_PLAN_INVALID_PRODUCT_TYPE

The request tried to create a plan, but the 'type' field of a product is set to 'goods'. The request was rejected. Corrective action: Add only products that have 'type' set to 'services'.

ERROR_CREATE_PLAN_MISSING_TIERS_OBJECT

The request tried to create a plan with 'billing_scheme' set to 'tiered', but the request does not define any tiers. The request was rejected. Corrective action: Set the 'tiers' object to contain one or more tiers.

ERROR_CREATE_PLAN_MISSING_TOP_TIER

The request tried to create a plan with 'billing_scheme' set to 'tiered', but the top tier was not defined. The request was rejected. Corrective action: Inside the 'tiers' object, for the top tier, set 'up_to' to 'inf'.

ERROR_CREATE_PLAN_PRODUCT_NOT_ACTIVE

The request tried to create a plan using a product that is not available for purchase. The request was rejected. Corrective action: Use 'Update Product' to set 'active' to true.

ERROR_CREATE_PLAN_TIER_PARAMETERS_NOT_VALID

The request tried to create a plan with 'billing_scheme' set to 'tiered', but the value for one of the fields in a tier object was not valid. The request was rejected. Corrective action: Set 'amount' and 'flat_amount' to a positive decimal number, and set 'up_to' to 'inf' or a positive integer.

ERROR_DELETE_PLAN

The request tried to delete a plan, but the operation failed. Corrective action: Determine whether the plan was already deleted, and why there were multiple requests to delete it.

ERROR_GET_PLAN

The request tried to retrieve a plan, but the plan was not found. The request was rejected. Corrective action: Use a valid plan ID.

ERROR_PLAN_CURRENCY_CODE_DOES_NOT_MATCH

The request tried to create a plan, but the currency of the subscription did not match the currency of all subscription items. The request was rejected. Corrective action: Add only plans that have the same currency as the subscription.

ERROR_PLAN_INTERVAL_COUNT_NOT_VALID

The request tried to create or update a plan, but the interval was defined for more than one year. The request was rejected. Corrective action: Provide correct values for 'interval' and 'interval_count' so that the defined interval is one year or less.

ERROR_PLAN_TRIAL_PERIOD_DAYS_DOES_NOT_MATCH

The request tried to create a plan, but the 'trial_period_days' field for the subscription did not match the 'trial_period_days' of all subscription items. The request was rejected. Corrective action: Add only plans that have the same 'trial_period_days' as the subscription, or change 'trial_period_days' in the relevant plans to match the value in the subscription.

ERROR_UPDATE_PLAN_INVALID_PRODUCT_TYPE

The request tried to update a plan, but the 'type' field of a product is set to 'goods'. The request was rejected. Corrective action: Add only products that have 'type' set to 'service'.

INVALID_AGGREGATE_USAGE

The request tried to create a plan, but the value of the 'aggregate_usage' body parameter was not recognized. The request was rejected. Corrective action: Set 'aggregate_usage' to one of the following values: 'max', 'sum', 'last_during_period', or 'last_ever'.

INVALID_AMOUNT_AND_TIERS

The request tried to create a plan, but the 'amount' and 'tiers' body parameters were both set. The request was rejected. Corrective action: Set 'amount' or 'tiers', but not both.

INVALID_BILLING_SCHEME

The request tried to create a plan, but the value of the 'billing_scheme' body parameter was unset or not recognized. The request was rejected. Corrective action: Set 'billing_scheme' to 'per_unit' or 'tiered'.

INVALID_PLAN_AND_PRODUCT

The request attempted an operation that requires a plan, but the plan was not found. The request was rejected. Corrective action: Use the ID of a valid plan.

INVALID_PLAN_ID

The request tried to retrieve a plan, but the plan was not found. The request was rejected. Corrective action: Use a valid plan ID.

INVALID_PLAN_INTERVAL

The request tried to create a plan or a subscription item. In the case of a plan, the 'interval' body parameter was not one of the following values: 'day', 'week', 'month', 'year'. In the case of a subscription item, the interval in the subscription item must be the same as the interval in the subscription. The request was rejected. Corrective action: Choose a correct value for 'interval', and make sure the intervals in the subscription and the subscription item are the same.

INVALID_TIERS

The request tried to create a plan, but one of the 'tier' objects failed to define 'amount' and 'up_to'. The request was rejected. Corrective action: Define the 'amount' and 'up_to' fields for each 'tier' object.

INVALID_TIERS_MODE

The request tried to create a plan, but the value for the 'tiers_mode' body parameter was not recognized. The request was rejected. Corrective action: Set 'tiers_mode' to one of the following values: 'graduated', 'volume'.

INVALID_TRANSFORM_USAGE

The request tried to create a plan, but the values for the fields of the 'transform_usage' object were not found or not recognized. The request was rejected. Corrective action: Set 'divide_by' to an integer and 'round' to 'up' or 'down'.

INVALID_TRIAL_PERIOD_DAYS

The request tried to create or update a plan, but the value of the 'trial_period_days' body parameter was not recognized. The request was rejected. Corrective action: Set 'trial_period_days' to a positive integer. If there is no free trial, do not set this parameter.

INVALID_USAGE_TYPE

The request tried to create a plan, but the value of the 'usage_type' body parameter was not recognized. The request was rejected. Corrective action: Set 'usage_type' to one of the following values: 'metered', 'licensed'.