v1

latestOpenAPI 3.0.02026-07-14311851.4 KB
Report

Retrieve Subscription report by Status

Retrieves Subscriptions' reports, filtering by status. The report will be sent by email, to the address inserted in the API's path.

get/report/subscriptionsByStatus

Query parameters

requesterEmailstring required
Example:user@vtex.com.br

Email that the report will be sent to

statusinteger required
Example:1

Binary OR of the following status: 1 - ACTIVE; 2 - PAUSED; 4 - CANCELED; 8 - EXPIRED

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK