Create Renewal Invoice

Create a DRAFT renewal invoice for the next billing cycle (idempotent).

Called by the Restate workflow handler to initiate subscription renewal. The invoice is created in DRAFT state and must be finalized separately.

Idempotency: If a DRAFT invoice already exists for this subscription’s next billing period, returns the existing invoice instead of creating a duplicate.

Returns status-based response for workflow orchestration:

status: “invoice_created”, “skipped”, or “stopped”
subscription_id, invoice_id: Present when status is “invoice_created”
reason: Explanation when status is “skipped” or “stopped”

Create a DRAFT renewal invoice for the next billing cycle (idempotent). Called by the Restate workflow handler to initiate subscription renewal. The invoice is created in DRAFT state and must be finalized separately. Idempotency: If a DRAFT invoice already exists for this subscription's next billing period, returns the existing invoice instead of creating a duplicate. Returns status-based response for workflow orchestration: - status: "invoice_created", "skipped", or "stopped" - subscription_id, invoice_id: Present when status is "invoice_created" - reason: Explanation when status is "skipped" or "stopped"

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired

account_idstringRequired

Response

Successful Response

statusstring

subscription_idstring or null

invoice_idstring or null

reasonstring or null

1	import requests
2
3	url = "https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/create-renewal-invoice"
4
5	payload = {}
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

Authentication

Path parameters

Headers

Response

Errors

1	{
2	"status": "invoice_created",
3	"subscription_id": "sub_8f3a2b7c9d1e4f6a",
4	"invoice_id": "inv_4d2c1b9e7f8a3c5d"
5	}