Zuplo
The Zuplo Developer API, powered by Zuplo

​Metering - Subscriptions

API Metering subscriptions

Endpoint:https://developer-api-main-8600723.self.zuplo.com

​Lists subscriptions

GET
https://developer-api-main-8600723.self.zuplo.com
/v1/metering/{bucketId}/subscriptions

Lists all subscriptions belonging to this bucket.

​Lists subscriptions › path Parameters

  • bucketId
    string · 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

    • data
      object[] · required
    • limit
      integer · uint32
    • offset
      integer · uint32
    • total
      integer · uint32

​Creates a subscription

POST
https://developer-api-main-8600723.self.zuplo.com
/v1/metering/{bucketId}/subscriptions

Creates a new subscription for this bucket.

​Creates a subscription › path Parameters

  • bucketId
    string · 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

  • planIds
    string[] · required
  • planExternalIds
    string[] · required
  • status
    string · enum · required
    Enum values:
    active
    inactive
    incomplete
    incomplete-expired
    trialing
    past-due
    canceled
    unpaid
  • type
    string · enum · required
    Enum values:
    periodic
  • renewalStrategy
    string · enum · required
    Enum values:
    monthly
    yearly
  • region
    string · enum · required
    Enum values:
    us-central1
    us-east1
    europe-west4
  • customerKey
    string · required
  • subscriptionExternalId
    string · required
  • customerExternalId
    string · required
  • quotaResetAnchor
    string · date-time
  • metadata
    object
  • trialEndStatus
    string
  • trialEndDate
    string · date-time
  • trialStartDate
    string · date-time
  • nextBillingCycle
    string · date-time
  • productKey
    string

​Creates a subscription › Responses

    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • id
      string · readOnly · required
    • planIds
      string[] · required
    • planExternalIds
      string[] · required
    • status
      string · enum · required
      Enum values:
      active
      inactive
      incomplete
      incomplete-expired
      trialing
      past-due
      canceled
      unpaid
    • type
      string · enum · required
      Enum values:
      periodic
    • renewalStrategy
      string · enum · required
      Enum values:
      monthly
      yearly
    • region
      string · enum · required
      Enum values:
      us-central1
      us-east1
      europe-west4
    • customerKey
      string · required
    • subscriptionExternalId
      string · required
    • customerExternalId
      string · required
    • quotaResetAnchor
      string · date-time
    • metadata
      object
    • trialEndStatus
      string
    • trialEndDate
      string · date-time
    • trialStartDate
      string · date-time
    • nextBillingCycle
      string · date-time
    • productKey
      string

​Gets a subscription

GET
https://developer-api-main-8600723.self.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Returns the details for a subscription.

​Gets a subscription › path Parameters

  • bucketId
    string · 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.

  • subscriptionId
    string · required

    The id of the subscription.

​Gets a subscription › Responses

    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • id
      string · readOnly · required
    • planIds
      string[] · required
    • planExternalIds
      string[] · required
    • status
      string · enum · required
      Enum values:
      active
      inactive
      incomplete
      incomplete-expired
      trialing
      past-due
      canceled
      unpaid
    • type
      string · enum · required
      Enum values:
      periodic
    • renewalStrategy
      string · enum · required
      Enum values:
      monthly
      yearly
    • region
      string · enum · required
      Enum values:
      us-central1
      us-east1
      europe-west4
    • customerKey
      string · required
    • subscriptionExternalId
      string · required
    • customerExternalId
      string · required
    • quotaResetAnchor
      string · date-time
    • metadata
      object
    • trialEndStatus
      string
    • trialEndDate
      string · date-time
    • trialStartDate
      string · date-time
    • nextBillingCycle
      string · date-time
    • productKey
      string

​Deletes a subscription

DELETE
https://developer-api-main-8600723.self.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Deletes a subscription and any related resources

​Deletes a subscription › path Parameters

  • bucketId
    string · 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.

  • subscriptionId
    string · required

    The id of the subscription.

​Deletes a subscription › Responses

    No response specified

​Updates a subscription

PATCH
https://developer-api-main-8600723.self.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Updates the subscription for this bucket.

​Updates a subscription › path Parameters

  • bucketId
    string · 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.

  • subscriptionId
    string · required

    The id of the subscription.

​Updates a subscription › Request Body

  • planExternalIds
    string[]
  • status
    string · enum
    Enum values:
    active
    inactive
    incomplete
    incomplete-expired
    trialing
    past-due
    canceled
    unpaid
  • prorate
    number
  • metadata
    object
  • trialEndDate
    string · date-time

​Updates a subscription › Responses

    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • id
      string · readOnly · required
    • planIds
      string[] · required
    • planExternalIds
      string[] · required
    • status
      string · enum · required
      Enum values:
      active
      inactive
      incomplete
      incomplete-expired
      trialing
      past-due
      canceled
      unpaid
    • type
      string · enum · required
      Enum values:
      periodic
    • renewalStrategy
      string · enum · required
      Enum values:
      monthly
      yearly
    • region
      string · enum · required
      Enum values:
      us-central1
      us-east1
      europe-west4
    • customerKey
      string · required
    • subscriptionExternalId
      string · required
    • customerExternalId
      string · required
    • quotaResetAnchor
      string · date-time
    • metadata
      object
    • trialEndStatus
      string
    • trialEndDate
      string · date-time
    • trialStartDate
      string · date-time
    • nextBillingCycle
      string · date-time
    • productKey
      string