> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Email the renewal again > Sends the buyer the link to pay their renewal again, for one whose renewal is waiting. Once an hour a subscription, and 20 every 10 minutes a store, whoever asks: after that the answer is 429. Refused with 409 where no renewal is waiting. The subscription as `data`, with `meta.history` (what happened to it, newest first) and `meta.orders` (its first order and every renewal). Needs the `subscriptions.write` permission (Change Subscriptions). It sends an email, and is counted against a budget of its own: 60 in ten minutes for each key. ## OpenAPI ````yaml /api-reference/openapi.json post /stores/{storeId}/subscriptions/{subscriptionId}/email openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/subscriptions/{subscriptionId}/email: post: tags: - Subscriptions summary: Email the renewal again description: >- Sends the buyer the link to pay their renewal again, for one whose renewal is waiting. Once an hour a subscription, and 20 every 10 minutes a store, whoever asks: after that the answer is 429. Refused with 409 where no renewal is waiting. The subscription as `data`, with `meta.history` (what happened to it, newest first) and `meta.orders` (its first order and every renewal). Needs the `subscriptions.write` permission (Change Subscriptions). It sends an email, and is counted against a budget of its own: 60 in ten minutes for each key. operationId: subscriptions.email parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: subscriptionId in: path required: true description: The subscription. schema: type: string - $ref: '#/components/parameters/IdempotencyKey' responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: id: type: string email: type: string customerId: nullable: true productId: type: string variantId: type: string productName: type: string variantName: type: string quantity: type: integer price: type: number currency: type: string every: type: integer unit: type: string status: type: string periodEnd: type: string graceEnd: nullable: true renewalOrderId: type: string renewalUrl: type: string firstOrderId: type: string cycles: type: integer remindedAt: type: string endedAt: nullable: true revoked: type: boolean pausedAt: nullable: true resumeAt: nullable: true pausedBy: nullable: true renewsWith: nullable: true autoRenews: type: boolean chargeTried: type: integer chargeNextAt: nullable: true createdAt: type: string meta: type: object properties: history: type: array items: type: object properties: kind: type: string detail: type: string actor: type: string orderId: type: string at: type: string orders: type: array items: type: object properties: id: type: string status: type: string amount: type: number currency: type: string renewal: type: boolean createdAt: type: string paidAt: nullable: true example: success: true message: null code: null data: id: d5b2ae58-5363-4806-bcaf-7fc939e2c948 email: grace@example.com customerId: null productId: f463e265-097a-4235-bc2f-5239b19a9874 variantId: 00e1d395-9ba2-4db3-900a-cb5e2811a2a9 productName: Northwind Pro variantName: 1 month quantity: 1 price: 9.99 currency: USD every: 1 unit: month status: active periodEnd: '2026-11-29T16:20:19Z' graceEnd: null renewalOrderId: e9ae5h0p1ye-cd7fded3be6-1006662 renewalUrl: >- http://localhost:3002/checkout/e9ae5h0p1ye-cd7fded3be6-1006662 firstOrderId: bc44febe-0f25-4076-92eb-03a5045a57e7 cycles: 1 remindedAt: '2026-10-22T16:20:19Z' endedAt: null revoked: false pausedAt: null resumeAt: null pausedBy: null renewsWith: null autoRenews: false chargeTried: 0 chargeNextAt: null createdAt: '2026-10-22T16:20:19Z' meta: history: - kind: reminded detail: Renewal email sent again, to grace@example.com. actor: merchant orderId: e9ae5h0p1ye-cd7fded3be6-1006662 at: '2026-10-22T16:20:19Z' - kind: renewal_made detail: >- Renewal made for Nov 29, 2026 to Dec 29, 2026, waiting to be paid. actor: system orderId: e9ae5h0p1ye-cd7fded3be6-1006662 at: '2026-10-22T16:20:19Z' orders: - id: e9ae5h0p1ye-cd7fded3be6-1006662 status: pending amount: 9.99 currency: USD renewal: true createdAt: '2026-10-22T16:20:19Z' paidAt: null - id: bc44febe-0f25-4076-92eb-03a5045a57e7 status: completed amount: 9.99 currency: USD renewal: false createdAt: '2026-10-22T16:20:19Z' paidAt: '2026-10-22T16:20:19Z' '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/Refused' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.subscriptions.email("SUBSCRIPTION_ID"); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->subscriptions->email('SUBSCRIPTION_ID'); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.subscriptions.email("SUBSCRIPTION_ID") components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with `Idempotent-Replay: true`. schema: type: string responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' Refused: description: >- The request was understood and not carried out. `validation_failed` says what is wrong with each field under `errors`; other codes are the route's own. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.