Zuplo
The Zuplo Developer API, powered by Zuplo

Metering - Subscriptions

Endpoint:https://dev.zuplo.com

Lists subscriptions

GET
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions

Lists subscriptions › path Parameters

  • bucketIdstring · required

Lists subscriptions › Responses

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

Creates a subscription

POST
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions

Creates a subscription › path Parameters

  • bucketIdstring · required

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

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    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}

Gets a subscription › path Parameters

  • bucketIdstring · required
  • subscriptionIdstring · required

Gets a subscription › Responses

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    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 › path Parameters

  • bucketIdstring · required
  • subscriptionIdstring · required

Deletes a subscription › Responses

No schema specified

Updates a subscription

PATCH
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Updates a subscription › path Parameters

  • bucketIdstring · required
  • subscriptionIdstring · required

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

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    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 - QuotasMetering - Plans