Update the Credits for a Subuser

API Overview

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console.

Operation overview

PUT/v3/subusers/{subuser_name}/credits

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

This endpoint allows you to update the Credits for a Subuser.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

subuser_namestringrequired

The username of the Subuser.

Request body

Schema

Property nameTypeRequiredDescriptionChild properties

typeenum<string>required

Type determines how credits are reset for a Subuser. unlimited indicates that there is no limit to the Subuser's credits. recurring indicates that the credits for the Subuser are reset according to the frequency determined by reset_frequency. nonrecurring indicates that there is no recurring schedule to reset credits and resets must be done on an ad hoc basis.

Possible values:

unlimitedrecurringnonrecurring

reset_frequencyenum<string>Optional

The frequency with which a Subuser's credits are reset if type is set to recurring. Do not include reset_frequency if you choose a reset type value of unlimited or nonrecurring.

Possible values:

monthlyweeklydaily

totalintegerOptional

Total number of credits to which the Subuser is to be reset. If type is nonrecurring then the Subuser's credits will be reset to total on a one-time basis. If type is recurring then the Subuser's credits will be reset to total every time a reset is scheduled in accordance with the reset_frequency. Do not include total if you choose a reset type value of unlimited.

Minimum: 1

Responses

200400

SchemaExample

Property nameTypeRequiredDescriptionChild properties

typeenum<string>

Possible values:

unlimitedrecurringnonrecurring

reset_frequencyenum<string> or null

The frequency with which a Subuser's credits are reset if type is set to recurring, otherwise null.

Possible values:

monthlyweeklydaily

remaininteger or null

Total number of remaining credits. remain is null if the reset type for the Subuser's credits is set to unlimited.

Minimum: 0

totalinteger or null

Total number of allowable credits. total is null if the reset type for the Subuser's credits is set to unlimited or nonrecurring.

Minimum: 0

usedinteger or null

Total number of used credits. used is null if the reset type for the Subuser's credits is set to unlimited or nonrecurring.

Minimum: 0

Update the Credits for a Subuser (recurring)

Reset the credits on a monthly basis

Node.js

Python

Java

PHP

Ruby

curl


_24const client = require('@sendgrid/client');
_24client.setApiKey(process.env.SENDGRID_API_KEY);
_24
_24const subuser_name = "some_one";
_24const data = {
_24  "type": "recurring",
_24  "reset_frequency": "monthly",
_24  "total": 100
_24};
_24
_24const request = {
_24  url: `/v3/subusers/${subuser_name}/credits`,
_24  method: 'PUT',
_24  body: data
_24}
_24
_24client.request(request)
_24  .then(([response, body]) => {
_24    console.log(response.statusCode);
_24    console.log(response.body);
_24  })
_24  .catch(error => {
_24    console.error(error);
_24  });

Update the Credits for a Subuser (non-recurring)

Reset the credits on a one-time basis

Node.js

Python

Java

PHP

Ruby

curl


_23const client = require('@sendgrid/client');
_23client.setApiKey(process.env.SENDGRID_API_KEY);
_23
_23const subuser_name = "some_one";
_23const data = {
_23  "type": "nonrecurring",
_23  "total": 100
_23};
_23
_23const request = {
_23  url: `/v3/subusers/${subuser_name}/credits`,
_23  method: 'PUT',
_23  body: data
_23}
_23
_23client.request(request)
_23  .then(([response, body]) => {
_23    console.log(response.statusCode);
_23    console.log(response.body);
_23  })
_23  .catch(error => {
_23    console.error(error);
_23  });

Update the Credits for a Subuser (unlimited)

Grant the Subuser unlimited credits

Node.js

Python

Java

PHP

Ruby

curl


_22const client = require('@sendgrid/client');
_22client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22const subuser_name = "some_one";
_22const data = {
_22  "type": "unlimited"
_22};
_22
_22const request = {
_22  url: `/v3/subusers/${subuser_name}/credits`,
_22  method: 'PUT',
_22  body: data
_22}
_22
_22client.request(request)
_22  .then(([response, body]) => {
_22    console.log(response.statusCode);
_22    console.log(response.body);
_22  })
_22  .catch(error => {
_22    console.error(error);
_22  });