The Zuplo Developer API, powered by Zuplo

Metering - Plans

API Metering plan management


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

Lists plans

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

Lists all plans belonging to this bucket.

Lists planspath 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 plansResponses

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

Creates a plan

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

Creates a new plan for this bucket.

Creates a planpath 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 planRequest Body

  • label
    string · required
  • planExternalId
    string · required
  • meters
    object · required
  • trialDays
    integer
  • trialEndStatus
    string · enum
    Enum values:
    paused
    canceled
  • isTrialCollectPayment
    boolean

Creates a planResponses

    • 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
    • hasSubscriptions
      boolean · readOnly · required
    • label
      string · required
    • planExternalId
      string · required
    • meters
      object · required
    • trialDays
      integer
    • trialEndStatus
      string · enum
      Enum values:
      paused
      canceled
    • isTrialCollectPayment
      boolean

Gets a plan

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

Returns the details for a plan.

Gets a planpath 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.

  • planId
    string · required

    The id of the plan.

Gets a planResponses

    • 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
    • hasSubscriptions
      boolean · readOnly · required
    • label
      string · required
    • planExternalId
      string · required
    • meters
      object · required
    • trialDays
      integer
    • trialEndStatus
      string · enum
      Enum values:
      paused
      canceled
    • isTrialCollectPayment
      boolean

Deletes a plan

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

Deletes a plan (if there are no associated subscriptions)

Deletes a planpath 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.

  • planId
    string · required

    The id of the plan.

Deletes a planResponses

    No response specified

Updates a plan

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

Update the details for a plan

Updates a planpath 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.

  • planId
    string · required

    The id of the plan.

Updates a planRequest Body

  • label
    string
  • planExternalId
    string
  • meters
    object
  • trialDays
    integer
  • trialEndStatus
    string · enum
    Enum values:
    paused
    canceled
  • isTrialCollectPayment
    boolean

Updates a planResponses

    • 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
    • hasSubscriptions
      boolean · readOnly · required
    • label
      string · required
    • planExternalId
      string · required
    • meters
      object · required
    • trialDays
      integer
    • trialEndStatus
      string · enum
      Enum values:
      paused
      canceled
    • isTrialCollectPayment
      boolean