Purchase order types
The Type column in the order details user interface is not a one-to-one match with the Type field in the API Order object. There are certain order types that are set in the API Order object as part of the subscription lifecycle that are not displayed in the user interface.
Order type displayed in UI | Order type returned by API | Description |
---|---|---|
Recurring | NEW | The purchase order contains flat fees (one-time or recurring) for this subscription. It will be active until a subscription update or cancellation takes place. |
Recurring | MIGRATION | The purchase order contains flat fees (one-time or recurring) for this subscription and is created upon a subscription update (it includes the flat fees, both for the recurring and one-time editions). This has nothing to do with a subscription migration, as the name might suggest. |
Recurring | ADOPTION | This purchase order is created when one admin takes ownership of another admin's subscription within the same company. |
Free Trial | FREE_TRIAL_ACTIVATION | This purchase order is created when a subscription was manually upgraded from a free trial to a regular active subscription. When the subscription automatically transitions from a free trial state to active state, the purchase order keeps the original NEW purchase order type. |
Recurring | END_OF_CONTRACT_MIGRATION | This purchase order is created when a subscription update takes places as a result of a contract extension. If the contract auto-renewal strategy is set to either continue without a contract or renew the contract with the same pricing plan, then no migration takes places, no END_OF_CONTRACT_MIGRATION purchase is created, and the original purchase order is simply updated to include the new end date for the contract. |
Recurring | END_OF_DISCOUNT_MIGRATION | This purchase order is created when a subscription update takes place as a result of a discount expiration. If a discount expires, the original purchase order is now invalid and an END_OF_DISCOUNT_MIGRATION is created to represent the updated costs without the discount |
One Time | ONE_TIME_FEE | This purchase order represents one time fees for the subscription. For example, setup fee or contract fee. This is different from flat fees that are billed once, in one-time billed products. |
Metered usage | METERED_USAGE | This purchase order is created for the purpose of accumulating usage fees during a billing period. Is only valid for the billing period but does change (depending on the usage) over the course of the billing period. A metered purchase order is invoiced in arrears at the end of the billing cycle. |
Additional fee | ADDITIONAL_FEE | This purchase order represents off order charges issued by the product developer, independent of the pricing plan. |
Termination fee | TERMINATION_FEE | This purchase order that contained a termination fee, was canceled. This purchase order represents the fees incurred as a result of the cancellation. |
Refund | REFUND | This purchase order is created to represent an issued refund. This only takes place for on-platform refunds. Off-platform refunds do not generate this type of purchase order |
Credit | CREDIT | This purchase order is created during subscription update events. Any subscription update will calculate a paid period and a credit period. The credit is then provided to the user to prorate the subscription. |
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!