Metering - Subscriptions
API Metering subscriptions
https://dev.zuplo.com
Lists subscriptions
Lists all subscriptions belonging to this bucket.
path Parameters
bucketId
string · requiredThe 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.
Responses
data
object[] · requiredlimit
integer · uint32offset
integer · uint32total
integer · uint32
Creates a subscription
Creates a new subscription for this bucket.
path Parameters
bucketId
string · requiredThe 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.
Request Body
planIds
string[] · requiredplanExternalIds
string[] · requiredstatus
string · enum · requiredEnum values:activeinactiveincompleteincomplete-expiredtrialingpast-duecanceledunpaidtype
string · enum · requiredEnum values:periodicrenewalStrategy
string · enum · requiredEnum values:monthlyyearlyregion
string · enum · requiredEnum values:us-central1us-east1europe-west4customerKey
string · requiredsubscriptionExternalId
string · requiredcustomerExternalId
string · required
quotaResetAnchor
string · date-timemetadata
objecttrialEndStatus
stringtrialEndDate
string · date-timetrialStartDate
string · date-timenextBillingCycle
string · date-timeproductKey
string
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredplanIds
string[] · requiredplanExternalIds
string[] · requiredstatus
string · enum · requiredEnum values:activeinactiveincompleteincomplete-expiredtrialingpast-duecanceledunpaidtype
string · enum · requiredEnum values:periodicrenewalStrategy
string · enum · requiredEnum values:monthlyyearlyregion
string · enum · requiredEnum values:us-central1us-east1europe-west4customerKey
string · requiredsubscriptionExternalId
string · requiredcustomerExternalId
string · requiredquotaResetAnchor
string · date-timemetadata
objecttrialEndStatus
stringtrialEndDate
string · date-timetrialStartDate
string · date-timenextBillingCycle
string · date-timeproductKey
string
Gets a subscription
Returns the details for a subscription.
path Parameters
bucketId
string · requiredThe 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.
subscriptionId
string · requiredThe id of the subscription.
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredplanIds
string[] · requiredplanExternalIds
string[] · requiredstatus
string · enum · requiredEnum values:activeinactiveincompleteincomplete-expiredtrialingpast-duecanceledunpaidtype
string · enum · requiredEnum values:periodicrenewalStrategy
string · enum · requiredEnum values:monthlyyearlyregion
string · enum · requiredEnum values:us-central1us-east1europe-west4customerKey
string · requiredsubscriptionExternalId
string · requiredcustomerExternalId
string · requiredquotaResetAnchor
string · date-timemetadata
objecttrialEndStatus
stringtrialEndDate
string · date-timetrialStartDate
string · date-timenextBillingCycle
string · date-timeproductKey
string
Deletes a subscription
Deletes a subscription and any related resources
path Parameters
bucketId
string · requiredThe 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.
subscriptionId
string · requiredThe id of the subscription.
Responses
Updates a subscription
Updates the subscription for this bucket.
path Parameters
bucketId
string · requiredThe 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.
subscriptionId
string · requiredThe id of the subscription.
Request Body
planExternalIds
string[]status
string · enumEnum values:activeinactiveincompleteincomplete-expiredtrialingpast-duecanceledunpaidprorate
numbermetadata
objecttrialEndDate
string · date-time
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredplanIds
string[] · requiredplanExternalIds
string[] · requiredstatus
string · enum · requiredEnum values:activeinactiveincompleteincomplete-expiredtrialingpast-duecanceledunpaidtype
string · enum · requiredEnum values:periodicrenewalStrategy
string · enum · requiredEnum values:monthlyyearlyregion
string · enum · requiredEnum values:us-central1us-east1europe-west4customerKey
string · requiredsubscriptionExternalId
string · requiredcustomerExternalId
string · requiredquotaResetAnchor
string · date-timemetadata
objecttrialEndStatus
stringtrialEndDate
string · date-timetrialStartDate
string · date-timenextBillingCycle
string · date-timeproductKey
string