Welcome to ZAPI - the Zuplo API where you can manage API keys, tunnels and more. To get your API key for this service login to portal.zuplo.com and navigate to your project Settings > Zuplo API Keys.
https://dev.zuplo.com
A Bucket is an object representing a group of API key consumers for a given account. This section includes a group of endpoints available to perform CRUD operations on a bucket. You can learn more about buckets here.
A Consumer is an object representing a group of API keys in a given bucket. This section includes a group of endpoints available to perform CRUD operations on a consumer. You can learn more about consumers here.
This is an object representing an API key. This section includes a list of endpoints to perform CRUD operations on an API key. You can learn more about API keys here.
Set of operations available to create and update environment variables. You can learn more about environment variables here.
Set of operations available to handle deployments. You can learn more about deployments here.
List of endpoints available to perform operations on Tunnels.
List of endpoints available to manage services for a given tunnel.
Lists all buckets belonging to this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
1
Creates a new bucket for this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
name
A friendly name for the bucket.
description
A description of the bucket.
tags
Key value pairs to associate with the bucket.
1
{
"name": "my-bucket",
"description": "Bucket for zuplo consumers",
"tags": {
"foo": "bar"
}
}
Returns the details for a bucket, including the token used to connect to the bucket.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
1
Updates a bucket, and returns the updated value.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
description
A description of the bucket.
tags
Key value pairs to associate with the bucket.
1
{
"description": "Bucket for zuplo consumers",
"tags": {
"foo": "bar"
}
}
Deletes a bucket and any related resources
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
1
Lists all consumers belonging to this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
limit
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offset
The offset of the first item returned in the collection. Default: 0
include-api-keys
Include the api key data in the response.
include-manager-invites
Include the manager invites data in the response.
include-managers
Include the manager's data in the response.
key-format
The format of the key to return.
none
: Key is completely hidden.
visible
: Key is completely visible.
masked
: Part of key suffix is visible.
none
visible
masked
manager-email
Filter by email address of key manager.
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
1
Creates a new consumer for this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
with-api-key
If an API key should be created with the consumer.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
name
A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.
managers
Email addresses of the managers to invite or a list of managers (with subs) to add to the consumer.
description
A description of the consumer.
tags
Key value pairs to associate with the consumer.
metadata
Generic metadata associated with the consumer.
1
{
"name": "zup-inc",
"description": "Consumer for zup inc",
"tags": {
"foo": "bar"
},
"metadata": {
"id": "zup-id-343"
},
"managers": [
{
"email": "user@example.com",
"sub": "oauth2|113533232396018044159"
}
]
}
Gets a consumer given a bucket name and consumer name.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
include-api-keys
Include the api key data in the response.
key-format
The format of the key to return.
none
: Key is completely hidden.
visible
: Key is completely visible.
masked
: Part of key suffix is visible.
none
visible
masked
include-managers
Include the manager's data in the response.
include-manager-invites
Include the manager invites data in the response.
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
1
Update the consumer with the matching consumer name.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
description
A description of the consumer.
tags
Key value pairs to associate with the consumer.
metadata
Generic metadata associated with the consumer.
1
{
"description": "Consumer for zup inc",
"tags": {
"foo": "bar"
},
"metadata": {
"id": "zup-id-343"
}
}
Deletes a consumer and any related resources
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
1
Set expiration for keys with no expiration date and creates a new key.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
expiresOn
When the item will expire.
1
{
"expiresOn": "2050-04-18T05:54:34.408Z"
}
Lists all keys for this consumer.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
limit
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offset
The offset of the first item returned in the collection. Default: 0
key-format
The format of the key to return.
none
: Key is completely hidden.
visible
: Key is completely visible.
masked
: Part of key suffix is visible.
none
visible
masked
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
1
Creates a new API key for this consumer. New API keys will automatically have API Key Leak Detection enabled.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
expiresOn
When the key expires.
description
The description of the api key.
key
The API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection
1
{
"description": "My secret api key",
"expiresOn": "2023-04-20T05:54:34.408Z",
"key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
}
Creates multiple new API keys for this consumer.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
Unnamed Property
1
[
{
"description": "My secret api key",
"expiresOn": "2023-04-20T05:54:34.408Z",
"key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
},
{
"description": "My secret api key2",
"expiresOn": "2023-05-20T05:54:34.408Z",
"key": "zpka_77b21c8591354c0997db232cc2f79c9e_69253f99"
}
]
Retrieves an API key for this consumer.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
key-format
The format of the key to return.
none
: Key is completely hidden.
visible
: Key is completely visible.
masked
: Part of key suffix is visible.
none
visible
masked
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
keyId
The key id.
1
Updates an API key for this consumer.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
keyId
The key id.
expiresOn
When the key expires.
description
The description of the api key.
key
The API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection
1
{
"expiresOn": "2023-04-18T05:54:34.0Z"
}
Deletes an API key for this consumer.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
tag
Query by tag. Example usage is tag.account=foo
, where account
is the name of the tag property and foo
is the value.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
keyId
The key id.
1
Creates a new environment variable in a branch for a given project.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
branchName
The name of the branch in your source control provider.
name
The name of the variable. Must be named in SCREAMING_SNAKE_CASE.
isSecret
Whether the variable is a secret.
value
The value of the variable.
1
{
"name": "PORTAL_ID",
"isSecret": false,
"value": "89333"
}
Update the value of a variable in a branch for a given project.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
branchName
The name of the branch in your source control provider.
variableName
The name of the environment variable.
value
The value of the variable.
1
{
"value": "89333"
}
Gets the deployment status of your upload. Use the UUID of the uploaded sources as the statusId
.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
statusId
The UUID of the uploaded sources.
1
Lists the deployments for the specified account and project.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
1
Creates a URL for uploading sources.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account
projectName
The name of the project
branchName
The name of the branch for deployment
1
{
"accountName": "my-account",
"projectName": "my-project",
"branchName": "main"
}
Gets the specified deployment.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
deploymentName
The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.
1
Deletes the specified deployment.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
deploymentName
The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.
1
Re-deploys the specified deployment so that it can pick up new environment variables or other configuration changes.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
deploymentName
The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.
1
Lists all tunnels belonging to this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
1
Creates a new tunnel for this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
name
A friendly name for the tunnel.
1
{
"tunnelId": "tnl_JcHFzTcJ9y4GU69lKBOaxFYU",
"name": "api-service-tunnel",
"token": "eyJhIjoiODJhNGM0ZTBlYWY3ZmU3YjQyMWRlZHU1ODhlNjg1ZGMiLCJ0IjoiNjY3ZWZhODktYzIyNS00NTIyLWI0M2EtYTgwYzY0OTgxMGY1IiwicyI6IkY5RGdVNnNNOTJWT245OUlUSWxMazVwY3lHV0ZLVG1jcHg2d0I5TkR4Vm89In0="
}
Returns the details for a tunnel, including the token used to connect to the tunnel.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
Deletes a tunnel and any services that it has.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
Rotates the token used to connect to the tunnel.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
This endpoint returns the status of the deletion of the tunnel. Tearing down the tunnel is an asynchronous process so this endpoint allows you to poll the status.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
operationId
The ID of the deletion operation.
1
This endpoint returns the status of the services that the tunnel is currently configured for. Provisioning the services is an asynchronous process so this endpoint allows you to poll the status.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
operationId
The ID of the operation.
1
This endpoint returns a snapshot of the services that the tunnel is currently configured for.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
This endpoint reads the request body and creates/updates/delete the services that the tunnel connects to.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
version
The version of this configuration format.
services
A list of services that the tunnel will connect to.
1
{
"version": 1,
"services": [
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
}
]
}
Lists all buckets belonging to this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
1
Creates a new bucket for this account.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
1
Returns the details for a bucket.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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.
1
Deletes a bucket and any related resources
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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.
1
Lists all plans belonging to this bucket.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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.
1
Creates a new plan for this bucket.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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.
label
planExternalId
meters
trialDays
trialEndStatus
paused
canceled
isTrialCollectPayment
1
{
"label": "Basic Subscription Plan",
"planExternalId": "prod_Pbyd5ARBWtFxkg",
"meters": {
"requests": {
"label": "Requests",
"max": 10
}
},
"trialDays": 10,
"trialEndStatus": "paused",
"isTrialCollectPayment": true
}
Returns the details for a plan.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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
The id of the plan.
1
Update the details for a plan
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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
The id of the plan.
label
planExternalId
meters
trialDays
trialEndStatus
paused
canceled
isTrialCollectPayment
1
{
"label": "Basic Subscription Plan",
"planExternalId": "prod_Pbyd5ARBWtFxkg",
"meters": {
"requests": {
"label": "Requests",
"max": 10
}
},
"trialDays": 10,
"trialEndStatus": "paused",
"isTrialCollectPayment": false
}
Deletes a plan (if there are no associated subscriptions)
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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
The id of the plan.
1
Lists all subscriptions belonging to this bucket.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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.
1
Creates a new subscription for this bucket.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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.
planIds
planExternalIds
quotaResetAnchor
status
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
type
periodic
renewalStrategy
monthly
yearly
region
us-central1
us-east1
europe-west4
customerKey
subscriptionExternalId
customerExternalId
metadata
trialEndStatus
trialEndDate
trialStartDate
1
{
"planIds": [
"plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"
],
"planExternalIds": [
"prod_Pbyd5ARBWtFxkg"
],
"quotaResetAnchor": "1904-10-14T23:22:33.0Z",
"status": "active",
"type": "periodic",
"renewalStrategy": "monthly",
"region": "us-east1",
"customerKey": "d8984b34-defd-458c-bf34-7fb1b69ce714",
"subscriptionExternalId": "sub_1OmlUlLQav6G4UBHsPy2BY7J",
"customerExternalId": "cus_PbzTcoZtPtelYg",
"metadata": {},
"trialEndStatus": "paused",
"trialEndDate": "1952-12-20T11:44:06.0Z",
"trialStartDate": "1903-11-08T04:28:08.0Z"
}
Returns the details for a subscription.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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
The id of the subscription.
1
Updates the subscription for this bucket.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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
The id of the subscription.
planExternalIds
status
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
prorate
metadata
trialEndDate
1
{
"status": "incomplete-expired",
"prorate": 0.75,
"metadata": {},
"trialEndDate": "1909-08-07T05:28:59.0Z"
}
Deletes a subscription and any related resources
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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
The id of the subscription.
1
Get the quotas for this subscription
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
bucketId
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
The id of the subscription.
1
Returns the OpenAPI V3 spec for Zuplo's Developer API
1
Returns basic information about the caller (using the api key)
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
1