The Zuplo Developer API, powered by Zuplo

Metering - Subscriptions

Endpoint:https://dev.zuplo.com

API Metering subscriptions

Lists subscriptions

GET

https://dev.zuplo.com

/v1/metering/{bucketId}/subscriptions

Lists all subscriptions belonging to this bucket.

Lists subscriptions › path Parameters

bucketIdstring · required
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.

Lists subscriptions › Responses

The request has succeeded.

dataobject[] · required

limitinteger · uint32
Example: 1000
offsetinteger · uint32
Example: 0
totalinteger · uint32

Creates a subscription

POST

https://dev.zuplo.com

/v1/metering/{bucketId}/subscriptions

Creates a new subscription for this bucket.

Creates a subscription › path Parameters

bucketIdstring · required
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.

Creates a subscription › Request Body

planIdsstring[] · required
Example: ["plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"]
planExternalIdsstring[] · required
Example: ["prod_Pbyd5ARBWtFxkg"]
statusstring · enum · required
Enum values:
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
unpaid
typestring · enum · required
Enum values:
periodic
renewalStrategystring · enum · required
Enum values:
monthly
yearly
regionstring · enum · required
Enum values:
us-central1
us-east1
europe-west4
customerKeystring · required
Example: d8984b34-defd-458c-bf34-7fb1b69ce714
subscriptionExternalIdstring · required
Example: sub_1OmlUlLQav6G4UBHsPy2BY7J
customerExternalIdstring · required
Example: cus_PbzTcoZtPtelYg

quotaResetAnchorstring · date-time
metadataobject
trialEndStatusstring
Example: paused
trialEndDatestring · date-time
trialStartDatestring · date-time
nextBillingCyclestring · date-time
productKeystring

Creates a subscription › Responses

The request has succeeded and a new resource has been created as a result.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required
Example: sbsc_BnCcCqQHM5H4z60sTR0FfCKg
planIdsstring[] · required
Example: ["plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"]
planExternalIdsstring[] · required
Example: ["prod_Pbyd5ARBWtFxkg"]
statusstring · enum · required
Enum values:
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
unpaid
typestring · enum · required
Enum values:
periodic
renewalStrategystring · enum · required
Enum values:
monthly
yearly
regionstring · enum · required
Enum values:
us-central1
us-east1
europe-west4
customerKeystring · required
Example: d8984b34-defd-458c-bf34-7fb1b69ce714
subscriptionExternalIdstring · required
Example: sub_1OmlUlLQav6G4UBHsPy2BY7J
customerExternalIdstring · required
Example: cus_PbzTcoZtPtelYg

quotaResetAnchorstring · date-time
metadataobject
trialEndStatusstring
Example: paused
trialEndDatestring · date-time
trialStartDatestring · date-time
nextBillingCyclestring · date-time
productKeystring

Gets a subscription

GET

https://dev.zuplo.com

/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Returns the details for a subscription.

Gets a subscription › path Parameters

bucketIdstring · required
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
subscriptionIdstring · required
The id of the subscription.

Gets a subscription › Responses

The request has succeeded.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required
Example: sbsc_BnCcCqQHM5H4z60sTR0FfCKg
planIdsstring[] · required
Example: ["plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"]
planExternalIdsstring[] · required
Example: ["prod_Pbyd5ARBWtFxkg"]
statusstring · enum · required
Enum values:
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
unpaid
typestring · enum · required
Enum values:
periodic
renewalStrategystring · enum · required
Enum values:
monthly
yearly
regionstring · enum · required
Enum values:
us-central1
us-east1
europe-west4
customerKeystring · required
Example: d8984b34-defd-458c-bf34-7fb1b69ce714
subscriptionExternalIdstring · required
Example: sub_1OmlUlLQav6G4UBHsPy2BY7J
customerExternalIdstring · required
Example: cus_PbzTcoZtPtelYg

quotaResetAnchorstring · date-time
metadataobject
trialEndStatusstring
Example: paused
trialEndDatestring · date-time
trialStartDatestring · date-time
nextBillingCyclestring · date-time
productKeystring

Deletes a subscription

DELETE

https://dev.zuplo.com

/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Deletes a subscription and any related resources

Deletes a subscription › path Parameters

bucketIdstring · required
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
subscriptionIdstring · required
The id of the subscription.

Deletes a subscription › Responses

There is no content to send for this request, but the headers may be useful.

No data returned

Updates a subscription

PATCH

https://dev.zuplo.com

/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Updates the subscription for this bucket.

Updates a subscription › path Parameters

bucketIdstring · required
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
subscriptionIdstring · required
The id of the subscription.

Updates a subscription › Request Body

planExternalIdsstring[]
Example: ["prod_Pbyd5ARBWtFxkg"]
statusstring · enum
Enum values:
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
unpaid
proratenumber
Example: 0.75
metadataobject
trialEndDatestring · date-time

Updates a subscription › Responses

The request has succeeded and a new resource has been created as a result.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required
Example: sbsc_BnCcCqQHM5H4z60sTR0FfCKg
planIdsstring[] · required
Example: ["plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"]
planExternalIdsstring[] · required
Example: ["prod_Pbyd5ARBWtFxkg"]
statusstring · enum · required
Enum values:
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
unpaid
typestring · enum · required
Enum values:
periodic
renewalStrategystring · enum · required
Enum values:
monthly
yearly
regionstring · enum · required
Enum values:
us-central1
us-east1
europe-west4
customerKeystring · required
Example: d8984b34-defd-458c-bf34-7fb1b69ce714
subscriptionExternalIdstring · required
Example: sub_1OmlUlLQav6G4UBHsPy2BY7J
customerExternalIdstring · required
Example: cus_PbzTcoZtPtelYg

quotaResetAnchorstring · date-time
metadataobject
trialEndStatusstring
Example: paused
trialEndDatestring · date-time
trialStartDatestring · date-time
nextBillingCyclestring · date-time
productKeystring

Metering - Quotas Metering - Plans