Metering - Plans
API Metering plan management
https://dev.zuplo.comLists plans
Lists all plans belonging to this bucket.
path Parameters
bucketIdstring · 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
dataobject[] · requiredlimitinteger · uint32offsetinteger · uint32totalinteger · uint32
Creates a plan
Creates a new plan for this bucket.
path Parameters
bucketIdstring · 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
labelstring · requiredplanExternalIdstring · requiredmetersobject · required
trialDaysintegertrialEndStatusstring · enumEnum values:pausedcanceledisTrialCollectPaymentboolean
Responses
createdOnstring · date-time · readOnly · requiredWhen the item was created.
updatedOnstring · date-time · readOnly · requiredWhen the item was last updated.
idstring · readOnly · requiredhasSubscriptionsboolean · readOnly · requiredlabelstring · requiredplanExternalIdstring · requiredmetersobject · requiredtrialDaysintegertrialEndStatusstring · enumEnum values:pausedcanceledisTrialCollectPaymentboolean
Gets a plan
Returns the details for a plan.
path Parameters
bucketIdstring · 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.
planIdstring · requiredThe id of the plan.
Responses
createdOnstring · date-time · readOnly · requiredWhen the item was created.
updatedOnstring · date-time · readOnly · requiredWhen the item was last updated.
idstring · readOnly · requiredhasSubscriptionsboolean · readOnly · requiredlabelstring · requiredplanExternalIdstring · requiredmetersobject · requiredtrialDaysintegertrialEndStatusstring · enumEnum values:pausedcanceledisTrialCollectPaymentboolean
Deletes a plan
Deletes a plan (if there are no associated subscriptions)
path Parameters
bucketIdstring · 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.
planIdstring · requiredThe id of the plan.
Responses
Updates a plan
Update the details for a plan
path Parameters
bucketIdstring · 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.
planIdstring · requiredThe id of the plan.
Request Body
labelstringplanExternalIdstringmetersobjecttrialDaysintegertrialEndStatusstring · enumEnum values:pausedcanceledisTrialCollectPaymentboolean
Responses
createdOnstring · date-time · readOnly · requiredWhen the item was created.
updatedOnstring · date-time · readOnly · requiredWhen the item was last updated.
idstring · readOnly · requiredhasSubscriptionsboolean · readOnly · requiredlabelstring · requiredplanExternalIdstring · requiredmetersobject · requiredtrialDaysintegertrialEndStatusstring · enumEnum values:pausedcanceledisTrialCollectPaymentboolean