Automate VTEX Subscriptions

What VTEX Subscriptions is

A **Subscription** is a list of items (SKUs) tied to certain recurring purchase settings: - User profile - Address - Payment method - Frequency - Cycle Once you have [configured subscriptions](https://help.vtex.com/tutorial/how-to-configure-subscriptions%20--1FA9dfE7vJqxBna9Nft5Sj) in your store, the Subscriptions API allows you to create, manage and monitor your customers' subscriptions. ![image]

API host: vtex.local

What HumDay can do in VTEX Subscriptions

10 documented operations change something in VTEX Subscriptions.

• POSTAdd item to subscription/api/rns/pub/subscriptions/{id}/items
• POSTCreate subscription/api/rns/pub/subscriptions
• POSTCalculate the current prices for the provided subscription template/api/rns/pub/subscriptions/simulate
• POSTEdit Subscriptions settings/api/rns/settings
• PATCHUpdate subscription/api/rns/pub/subscriptions/{id}
• DELETERemove items from a subscription./api/rns/pub/subscriptions/{id}/items/{itemId}
• PATCHEdit items on a subscription./api/rns/pub/subscriptions/{id}/items/{itemId}
• POSTCalculate the current prices for a specific subscription/api/rns/pub/subscriptions/{id}/simulate
• POSTRetry cycle/api/rns/pub/cycles/{cycleId}/retry
• POSTGenerate report/api/rns/pvt/reports/{reportName}/documents

What HumDay can read from VTEX Subscriptions

These are the operations a schedule or a trigger can watch.

• GETGet Subscription Settings/api/rns/settings
• GETList plans/api/rns/pvt/plans
• GETList cycles/api/rns/pub/cycles
• GETList report templates/api/rns/pvt/reports
• GETList subscriptions/api/rns/pub/subscriptions
• GETGet conversation messages/api/rns/pub/subscriptions/{subscriptionId}/conversation-message
• GETGet subscription details/api/rns/pub/subscriptions/{id}
• GETGet plan details/api/rns/pvt/plans/{id}
• GETGet cycle details/api/rns/pub/cycles/{cycleId}
• GETGet report document details/api/rns/pvt/reports/{reportName}/documents/{documentId}

How automating VTEX Subscriptions works

1. Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
2. Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
3. See it proven. The program runs and shows you the result before it is allowed near your live VTEX Subscriptions account.
4. Grant access, then go live. You approve the specific VTEX Subscriptions operations it may use — and only those.

Automate VTEX Subscriptions with these

• VTEX Catalog162 operations
• VTEX Catalog Seller Portal16 operations
• VTEX Checkout32 operations
• VTEX Customer Credit26 operations
• VTEX Do8 operations
• VTEX GiftCard11 operations
• VTEX GiftCard Hub15 operations
• VTEX Headless CMS3 operations
• VTEX Intelligent Search7 operations
• VTEX Legacy Search15 operations
• VTEX License Manager12 operations
• VTEX Logistics53 operations

Questions about VTEX Subscriptions automation

Can HumDay connect to VTEX Subscriptions?

Yes. HumDay reads VTEX Subscriptions's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 20 operations are documented.

Do I need to write code to automate VTEX Subscriptions?

No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your VTEX Subscriptions account.

What can HumDay do in VTEX Subscriptions?

10 of the 20 documented operations change something in VTEX Subscriptions, and 10 read from it. HumDay only ever uses the specific operations your approved contract needs.

Is my VTEX Subscriptions account safe?

Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to VTEX Subscriptions is held behind that approval.

Where this came from

The operations above are read from a published API description for VTEX Subscriptions at raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Subscriptions API (v3).json. Descriptions are the provider’s own words, not ours. Last published 2023-03-03.