Documentation

ERROR_CREATE_PRODUCT_DUPLICATE_PRODUCT_ID

The request tried to validate identity, but the 'id' body parameter was previously used. The request was rejected. Corrective action: Provide a unique product ID for each identity verification operation, whether successful or unsuccessful.

ERROR_CREATE_SERVICE_PACKAGE_DIMENSIONS_NOT_ALLOWED

The request tried to create a product of type 'service', but package dimensions were specified. The request was rejected. Corrective action: Set 'package_dimensions' to null.

ERROR_DELETE_PRODUCT

The request tried to delete a product, but the product was not found. The request was rejected. Corrective action: Determine whether the product was already deleted, and why there were multiple requests to delete it.

ERROR_DELETE_PRODUCT_ACTIVE_SUBSCRIPTION

The request tried to delete a product, but the product is referred to in a plan that is the basis for one or more subscriptions. The request was rejected. Corrective action: Cancel all subscriptions that are associated with the product.

ERROR_GET_PRODUCT

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

ERROR_PRODUCT_ATTRIBUTE_MUST_BE_STRING

The request tried to create a product, but the 'attributes' field was not an array of strings. The request was rejected. Corrective action: Use an array of strings.

ERROR_SHIPPING_NOT_ALLOWED_FOR_PRODUCT_TYPE_SERVICE

The request tried to create a product of type 'service', but the 'shippable' field was set to 'true'. The request was rejected. Corrective action: Set 'shippable' to null or 'false'.

INVALID_PARAMETER_STATEMENT_DESCRIPTOR_MUST_BE_EMPTY

The request tried to create a product of type 'goods', but the statement descriptor was set. The request was rejected. Corrective action: Set 'statement_descriptor' to null.

INVALID_PARAMETER_UNIT_LABEL_MUST_BE_EMPTY

The request tried to create a product of type='goods', but the 'unit_label' field contained a value. The request was rejected. Corrective action: Use an empty string.

INVALID_PRODUCT

The request tried to perform an operation that requires a product, but the product was not found. The request was rejected. Corrective action: Use a valid product ID.

INVALID_PRODUCT_ATTRIBUTES

The request tried to create or update a product, but the 'attributes' body parameter was not found or is not an array. The request was rejected. Corrective action: Define the 'attributes' body parameter as an array.

INVALID_PRODUCT_ATTRIBUTES_LIMIT

The request tried to create or update a product, but the 'attributes' array contained more than 5 elements. The request was rejected. Corrective action: Define the 'attributes' body parameter as an array of zero to five strings.

INVALID_PRODUCT_ATTRIBUTES_MUST_BE_UNIQUE

The request tried to create a product, but the list of attributes contained a duplicate value. The request was rejected. Corrective action: In the 'attributes' array, list each string only one time.

INVALID_PRODUCT_IMAGES

The request tried to create a product, but the 'images' body parameter was not an array. The request was rejected. Corrective action: Define the 'images' body parameter as an array.

INVALID_PRODUCT_NAME

The request tried to create a product, but the 'name' body parameter was empty or not found. The request was rejected. Corrective action: Define the 'name' body parameter.

INVALID_PRODUCT_TYPE

The request tried to create a product, but the value for the 'type' body parameter was not recognized. The request was rejected. Corrective action: Define the 'type' body parameter as 'service' or 'goods'.

INVALID_STATEMENT_DESCRIPTOR

The request attempted an operation that uses a statement descriptor, but it contained illegal characters. The request was rejected. Corrective action: For the 'statement_descriptor' body parameter, use a string of 1-22 alphanumeric characters and spaces.