Update a purchase

patch

https://api.mobilize.io/v1.1/commerce/purchases/{purchase_id}

Changes a purchase's entitlement window or its external identifiers. Nothing else about a
purchase can be changed; correcting the product, user, or price means recording a new one.

Extending expires_on beyond today restores access to a purchase whose window had
lapsed — expired is not a terminal state. A cancelled or rescinded purchase cannot be
updated at all.

Only a purchase whose commerce provider accepts changes from this API can be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

purchase_id

string

required

One of the following:

The UUID uniquely associated with a purchase
|
A pair consisting of an External ID Namespace and an External ID, separated by a : character.
The Namespace component may not contain the characters : or /.

Body Params

The fields to change. Anything omitted is left as it is, including the individual dates
within entitlement.

If starts_on is explicitly null, the entitlement start date will be updated to equal the
date of purchase.

external_ids

array of objects

length ≥ 1

The purchase's complete set of namespaced external identifiers. Any identifier the
purchase carries and this array omits is removed, so a purchase always keeps at least
one. An identifier already mapped to another purchase returns 422.

external_ids

string

required

An arbitrary identifier for a supported resource in Journey by Forj.
Must be unique within its namespace.

namespace

string

required

^[^:/]+$

An arbitrary category for disambiguating External IDs

entitlement

object

The window during which this purchase entitles the user to the product. Send either date
as null for a purchase that starts immediately or never expires.

A window that has already elapsed is accepted rather than rejected: the entitlement
reports expired and grants no access.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The purchase as it stands after the change.

400There was a problem with the request. Refer to the response body for details.

401Credentials were missing from the request or were not valid.

404The requested resource was not found.

422There was a problem with the request. Refer to the response body for details.

429The rate limit of 100 requests per minute per source IP address was exceeded. Enforced at the load balancer ahead of the application; the response has no body.