Order webhook payload

The resource:url for an Order webhook payload uses this basic format:

https://marketplace_url/api/billing/v1/orders/order_id

Here marketplace_url is the URL for the marketplace (for example, mycompany.byappdirect.com ), and order_id is the "id" value that the marketplace has generated for this specific order (for example, 123456789).

When an Order:Added or Order:Changed webhook is triggered, the content payload matches the REST API Order definition for the order.

Each Order includes one or more Order lines. The attributes in these sections of the order are described in the REST API OrderLine definition.

The payload also includes the following additional attributes that do not appear in the REST API documentation:

Attribute	Type	Description
transactionMode	Enum	Deprecated (no longer used).
paymentPlan:
{...}:keepBillDateOn PricingPlanChange	Boolean	Whether the billing cycle date remains the same when the user changes to a new pricing plan.
{...}:cost:edition PricingItemUuid	String	A universally unique identifier (uuid) that identifies the pricing item.
orderLine:description	String	A brief description of the order line.

The following attributes already appear in the REST API definition, but are described here with more information:

Attribute	Type	Description
status	Enum	The current status of the order. Must be one of INITIALIZED, PENDING_USER_APPROVAL, PENDING_REMOTE_CREATION, PENDING_MANUAL_RECOVERY, PENDING_ASYNCHRONOUS_CREATION, FREE_TRIAL, ACTIVE, FINISHED, ONE_TIME, CANCELLED, SUSPENDED, FREE_TRIAL_EXPIRED, FREE_TRIAL_CANCELLED, DELETED, UPCOMING, FAILED, PENDING_MIGRATION_ACTIVATION, PENDING_DELAYED_PROVISIONING, or PENDING_REMOTE_APPROVAL
frequency	Enum	A code indicating how often the customer is invoiced for the order. Must be one of DAILY, MONTHLY, QUARTERLY, SIX_MONTHS, YEARLY, TWO_YEARS, or THREE_YEARS.
type	Enum	A code that briefly describes the order. Must be one of NEW, MIGRATION, ADOPTION, FREE_TRIAL_ACTIVATION, TERMINATION_FEE, END_OF_CONTRACT_MIGRATION, REFUND, CREDIT, ADDITIONAL_FEE, ONE_TIME_FEE, END_OF_DISCOUNT_MIGRATION, METERED_USAGE, BUNDLED, METERED_USAGE_V2, or METERED_USAGE_CREDIT.
referenceCode	String	The reference code, if this is defined as a subscription custom attribute. Deprecated (the value is always "null").
id	Number	The main identifier for the order. This ID number is generated by the marketplace.