Subscription Payment Due
v0.0.1eventsEmitted when a subscription payment is due for collection
1{
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "type": "object",
4 "properties": {
5 "subscriptionId": {
6 "type": "string",
7 "description": "Unique identifier for the subscription"
8 },
9 "customerId": {
10 "type": "string",
11 "description": "Unique identifier for the customer"
12 },
13 "invoiceId": {
14 "type": "string",
15 "description": "Unique identifier for the invoice"
16 },
17 "amount": {
18 "type": "number",
19 "description": "Amount due for payment"
20 },
21 "currency": {
22 "type": "string",
23 "description": "Currency code (ISO 4217)"
24 },
25 "dueDate": {
26 "type": "string",
27 "format": "date-time",
28 "description": "When the payment is due"
29 },
30 "billingPeriod": {
31 "type": "object",
32 "properties": {
33 "start": {
34 "type": "string",
35 "format": "date"
36 },
37 "end": {
38 "type": "string",
39 "format": "date"
40 }
41 },
42 "required": ["start", "end"]
43 },
44 "planId": {
45 "type": "string",
46 "description": "Subscription plan identifier"
47 },
48 "retryAttempt": {
49 "type": "integer",
50 "description": "Number of retry attempts for failed payments"
51 }
52 },
53 "required": ["subscriptionId", "customerId", "invoiceId", "amount", "currency", "dueDate"]
54}Details
- Format
- JSON Schema
- Resource
- events
- Filename
- schema.json