Plugin Subscriptions

Create plugin subscription

POST

http://localhost:3000/api/plugins/{pluginId}/subscriptions

curl -X POST 'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/subscriptions' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "pluginId": "string",
  "planId": "string",
  "scope": "tenant",
  "autoRenew": true,
  "paymentMethod": "string",
  "promoCode": "string",
  "metadata": {}
}'

const body = `{
  "pluginId": "string",
  "planId": "string",
  "scope": "tenant",
  "autoRenew": true,
  "paymentMethod": "string",
  "promoCode": "string",
  "metadata": {}
}`;

const response = await fetch('http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/subscriptions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "pluginId": "string",
  "planId": "string",
  "scope": "tenant",
  "autoRenew": true,
  "paymentMethod": "string",
  "promoCode": "string",
  "metadata": {}
}'''

response = requests.post(
    'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/subscriptions',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "pluginId": "string",
  "planId": "string",
  "scope": "tenant",
  "autoRenew": true,
  "paymentMethod": "string",
  "promoCode": "string",
  "metadata": {}
}

201

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "status": "active",
  "scope": "tenant",
  "startDate": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "trialEndDate": "2024-01-15T09:30:00Z",
  "autoRenew": true,
  "cancelledAt": "2024-01-15T09:30:00Z",
  "cancellationReason": "string",
  "metadata": {},
  "externalSubscriptionId": "string",
  "pluginId": "string",
  "pluginTenantId": "string",
  "planId": "string",
  "subscriberId": "string",
  "parentId": "string",
  "children": [],
  "billings": [
    "string"
  ]
}

Body

application/json

pluginIdstringrequired

Plugin ID

planIdstring

Plan ID

scopestringtenantorganizationuserrequired

Subscription scope

autoRenewbooleanrequired

Auto-renewal enabled

paymentMethodstring

Payment method

promoCodestring

Promo code

metadataobject

Additional metadata

Parameters

pluginIdstring<uuid>requiredpath

Plugin ID

Response

201CreatedPluginSubscription_1

Plugin subscription created successfully

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

statusstringactivecancelledexpiredtrialpast_duesuspendedpendingrequired

Subscription status

scopestringtenantorganizationuserrequired

Subscription scope

startDatestring<date-time>required

Start date of subscription

endDatestring<date-time>

End date of subscription

trialEndDatestring<date-time>

Trial end date

autoRenewbooleanrequired

Whether auto-renewal is enabled

cancelledAtstring<date-time>

Cancellation date

cancellationReasonstring

Cancellation reason

metadataobject

Subscription metadata for additional data

externalSubscriptionIdstring

External subscription ID from payment provider

pluginIdstringrequired

Plugin ID

pluginTenantIdstringrequired

Plugin Tenant ID

planIdstring

Subscription plan ID

subscriberIdstring

Subscriber user ID for user-specific subscriptions

parentIdstring

Parent subscription ID for hierarchical subscriptions

parentPluginSubscription_1

Parent subscription (for subscriptions created through assignment)

Show child attributes

PluginSubscription_1

childrenArray<PluginSubscription_1>

Child subscriptions (user subscriptions created through assignment)

Same fields as PluginSubscription_1

billingsArray<string>

Plugin billings for this subscription

Stack Overflow Website Demo