godaddy.subscriptions
Module godaddy.subscriptions
API
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_godaddy.subscriptions_1.5.1.png)
ballerinax/godaddy.subscriptions Ballerina library
Overview
This is a generated connector for GoDaddy Subscriptions API v1 OpenAPI specification.
The GoDaddy Subscriptions API provides capability to access GoDaddy operations related to subscriptions.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an GoDaddy account
- Obtain tokens
- Follow this link to obtain tokens
Clients![](/images/permalink.svg)
godaddy.subscriptions: Client![](/images/permalink.svg)
This is a generated connector for GoDaddy Subscriptions API v1 OpenAPI specification. The GoDaddy Subscriptions API provides capability to access GoDaddy operations related to subscriptions.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a GoDaddy and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ote-godaddy.com/" - URL of the target service
listSubscriptions![](/images/permalink.svg)
function listSubscriptions(string? xShopperId, string xMarketId, string[]? productGroupKeys, string[]? includes, int offset, int 'limit, string sort) returns SubscriptionList|error
Retrieve a list of Subscriptions for the specified Shopper
Parameters
- xShopperId string? (default ()) - Shopper ID to return subscriptions for when not using JWT
- xMarketId string (default "en-US") - The market that the response should be formatted for
- productGroupKeys string[]? (default ()) - Only return Subscriptions with the specified product groups
- includes string[]? (default ()) - Optional details to be included in the response
- offset int (default 0) - Number of Subscriptions to skip before starting to return paged results (must be a multiple of the limit)
- 'limit int (default 25) - Number of Subscriptions to retrieve in this page, starting after offset
- sort string (default "-expiresAt") - Property name that will be used to sort results. "-" indicates descending
Return Type
- SubscriptionList|error - Request was successful
listProductGroups![](/images/permalink.svg)
function listProductGroups(string? xShopperId, string xMarketId) returns ProductGroup[]|error
Retrieve a list of ProductGroups for the specified Shopper
Parameters
- xShopperId string? (default ()) - Shopper ID to return data for when not using JWT
- xMarketId string (default "en-US") - The market that the response should be formatted for
Return Type
- ProductGroup[]|error - Request was successful
getSubscription![](/images/permalink.svg)
function getSubscription(string subscriptionId, string? xShopperId, string xMarketId) returns Subscription|error
Retrieve details for the specified Subscription
Parameters
- subscriptionId string - Unique identifier of the Subscription to retrieve
- xShopperId string? (default ()) - Shopper ID to be operated on, if different from JWT
- xMarketId string (default "en-US") - Unique identifier of the Market in which the request is happening
Return Type
- Subscription|error - Request was successful
cancelSubscription![](/images/permalink.svg)
Cancel the specified Subscription
Parameters
- subscriptionId string - Unique identifier of the Subscription to cancel
- xShopperId string? (default ()) - Shopper ID to cancel subscriptions for when not using JWT
updateSubscription![](/images/permalink.svg)
function updateSubscription(string subscriptionId, SubscriptionUpdate payload) returns Response|error
Update details for the specified Subscription
Parameters
- subscriptionId string - Unique identifier of the Subscription to update
- payload SubscriptionUpdate - Details of the Subscription to change
Records![](/images/permalink.svg)
godaddy.subscriptions: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string -
godaddy.subscriptions: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
godaddy.subscriptions: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
godaddy.subscriptions: Error![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorField[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
godaddy.subscriptions: ErrorField![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- message string? - Human-readable, English description of the problem with the contents of the field
- path string - <ul> <li style='margin-left: 12px;'>JSONPath referring to a field containing an error</li> <strong style='margin-left: 12px;'>OR</strong> <li style='margin-left: 12px;'>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li> </ul>
- pathRelated string? - JSONPath referring to a field containing an error, which is referenced by
path
godaddy.subscriptions: ErrorLimit![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorField[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
- retryAfterSec int - Number of seconds to wait before attempting a similar request
godaddy.subscriptions: Pagination![](/images/permalink.svg)
Fields
- first string? - URI to access the first page
- last string? - URI to access the last page
- next string? - URI to access the next page
- previous string? - URI to access the previous page
- total int? - Number of records available
godaddy.subscriptions: ProductGroup![](/images/permalink.svg)
Fields
- productGroupKey string - Primary key of a grouping of related Subscriptions
- subscriptionCount int - The number of Subscriptions that the shopper owns in this group
godaddy.subscriptions: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
godaddy.subscriptions: Subscription![](/images/permalink.svg)
Fields
- addons SubscriptionAddon[]? - An array of additional products that have been purchased to augment this Subscription
- billing SubscriptionBilling -
- cancelable boolean? - Whether or not the Subscription is allowed to be canceled
- createdAt string - When the Subscription was created
- expiresAt string? - When the Subscription will expire
- label string? - A human readable description of this Subscription
- launchUrl string? - The url to use or manage this Subscription's active product
- paymentProfileId int? - Unique identifier of the payment profile that will be used to automatically renew this Subscription
- priceLocked boolean - Whether the renewal price will be based from the list price or a locked-in price for this shopper
- product SubscriptionProduct -
- relations SubscriptionRelations? -
- renewAuto boolean - Whether or not the Subscription is set to be automatically renewed via the billing agent
- renewable boolean - Whether or not the Subscription is allowed to be renewed
- status string - Whether the Subscription is active or the specific non-active state
- subscriptionId string - Unique identifier of the Subscription
- upgradeable boolean - Whether or not the Subscription is allowed to be upgraded
godaddy.subscriptions: SubscriptionAddon![](/images/permalink.svg)
Fields
- commitment string - The financial commitment the customer has in the product
- pfid int - Unique identifier of the add-in product
- quantity int -
godaddy.subscriptions: SubscriptionBilling![](/images/permalink.svg)
Fields
- commitment string - The financial commitment the customer has in the product
- pastDueTypes string[]? - The types of charges that are past due when
status
is PAST_DUE
- renewAt string - The point in time after which the Subscription will bill for automatic renewal
- status string - Whether payments are past due
godaddy.subscriptions: SubscriptionList![](/images/permalink.svg)
Fields
- pagination Pagination -
- subscriptions Subscription[] - A collection of subscriptions
godaddy.subscriptions: SubscriptionProduct![](/images/permalink.svg)
Fields
- label string - A human readable description of the Product that is subscribed
- namespace string - Grouping of related Subscriptions
- pfid int - Unique identifier of the Product that is subscribed
- productGroupKey string - Primary key of a grouping of related Subscriptions
- renewalPeriod int - The number of
renewalPeriodUnits
that will be added by therenewalPfid
- renewalPeriodUnit string - The unit of time that
renewalPeriod
is measured in
- renewalPfid int - Unique identifier of the renewal Product
- supportBillOn boolean - Whether the product supports the
billOn
option on the renewal endpoint
godaddy.subscriptions: SubscriptionRelations![](/images/permalink.svg)
Fields
- children string[]? - A set of related Subscriptions that will be canceled automatically if this Subscription is canceled
- parent string? - Unique identifier of this Subscription's parent
godaddy.subscriptions: SubscriptionUpdate![](/images/permalink.svg)
Fields
- paymentProfileId int? - Unique identifier of the payment profile you want to be used for automatic renewal
- renewAuto boolean? - Whether or not you want the Subscription renew automatically
Import
import ballerinax/godaddy.subscriptions;
Metadata
Released date: over 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Website & App Building/Website Builders
Cost/Paid
Contributors
Dependencies