Retrieve the status of a subscription set up during checkout

Call this after the shopper completes a recurring-payment checkout (for example, paying for a membership by subscription), using the signed merchant reference and signature you were handed back, to find out whether the recurring contract was set up successfully.

Headers

x-entriastringRequired
Identifies which store this request is for. Required on every store-scoped route. It is not authentication and not a secret — it grants no privileges and is safe to send from a browser. You receive the value once your Entria backend has been created and configured. Missing header returns 400; an unknown store returns 404.

Query parameters

merchantReferencestringRequired
The merchant reference from the signed URL you were given after checkout completed.
sigstringRequired

The signature issued alongside merchantReference; both must be presented together to prove the request is legitimate.

Response

The subscription setup has reached a final outcome. status is completed if the recurring contract was created successfully, in which case any resulting membership ids are included, or failed if it was not — use this to show the shopper the right outcome.

statusenum
Allowed values:
membershipIdslist of stringsOptional

Errors

400
Bad Request Error
401
Unauthorized Error