Menu

Expand
Rate this page:

Account Provisioning API: Offering Operations

The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customers. This API is for companies that have a formal reseller partnership with Twilio SendGrid.

You can access Twilio SendGrid sub-account functionality without becoming a reseller. If you require sub-account functionality, see the Twilio SendGrid Subusers feature, which is available with Pro and Premier plans.

The Account Provisioning API offering operations allow you to update and list Twilio SendGrid features or offerings available for your customer accounts.

List Offerings

The List Offerings operation returns all the Twilio SendGrid features or offerings available to a reseller account. These offerings can be assigned to the reseller's customer accounts when creating a new customer account with the Create Account operation. Offerings can be added to or removed from a customer account using the Update Account Offerings operation.

Because the available offerings will change infrequently, you may wish to cache the List Offerings response rather than call the endpoint before each account creation or update.

GET /v3/partners/offerings

Base url: https://api.sendgrid.com

Retrieves offerings available under the organization.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Responses

object
catalog
array[object]
offering
object

An offering is a package (email infrastructure) or add-on (marketing campaigns, dedicated IP addresses, EASE) that an account can acquire. Each offering has a list of entitlements that indicate the benefits the account receives from the acquisition.

name
string

Name of the offering

required
type
string

Defines the type of offering (e.g., package or addon).

Allowed Values: package, addon
required
quantity
integer

Quantity of the specified addon to be added. If offering type is package, quantity must be 1.

format: int64
entitlements
object

Set of entitlements the specified offering comes with

email_sends_max_monthly
integer

Total number of email sends per month

format: int64
ip_count
integer

Number of dedicated IPs offered

format: int64
teammates_max_total
integer

Total number of teammates allowed

format: int64
users_max_total
integer

Total number of subusers allowed

format: int64
{
  "account_id": "sg2a2bcd3ef4ab5c67d8efab91c01de2fa"
}
object
errors
array[object]
required
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
Loading Code Sample...
        
        

        Get all offerings available to the reseller account

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif