API standards

This article covers some key global standards Recharge abides by.

Attribute keys

• All attribute keys should be lowercase snake case. Example: order_id
• All attribute keys on a resource are ordered according to the following standards:
  • The primary key (id) appears first in the object body.
  • Secondary keys relating an object to other resources appear next, in alphabetical order.
  • All other attributes of an object appear next, in alphabetical order.

Formats

• All date and date-time values are formatted in the ISO 8601 standard and in UTC.
• All records of a list response will be sorted by id descending unless otherwise specified using a sort_by parameter in the request.
• The list of attributes in any resource doesn’t change based on the ecommerce platform. For example, references to external IDs such as the product ID or customer ID in the e-commerce platform are contained within a standard field name prefixed by the term external. For example, external_product_id instead of shopify_product_id. This ensures that you don’t have to adjust your integration code based on the underlying e-commerce platform.
• All external IDs are formatted as strings.
• All amounts, such as product prices, are formatted as strings.
• Any rate value inside a tax_lines object is displayed to four decimal places to accurately reflect tax rates. For example, a 12.5% tax rate is reflected as 0.1250.
• All dollar amounts, such as product prices, are formatted as strings.

Errors

From 2021-11, onward we use the following grid of errors codes: