Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Update the remaining credits for a Subuser

API Overview

api-overview page anchor

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console(link takes you to an external page).

Operation overview

operation-overview page anchor

PATCH/v3/subusers/{subuser_name}/credits/remaining

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to update the remaining credits for a Subuser.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
subuser_namestringrequired

The username of the Subuser.

Request body

request-body page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
allocation_updateintegerrequired

The number of credits to add to or subtract from the current remaining credits for the Subuser. Use a positive number to increase the remaining credits or a negative number to reduce the remaining credits.

Responses

responses page anchor
200400
SchemaExample
Property nameTypeRequiredDescriptionChild properties
typeenum<string>

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> 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 remaining credits for a Subuser (Add)Link to code sample: Update the remaining credits for a Subuser (Add)
1
const client = require('@sendgrid/client');

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const subuser_name = "some_one";

5
const data = {

6
  "allocation_update": 10

7
};

8


9
const request = {

10
  url: `/v3/subusers/${subuser_name}/credits/remaining`,

11
  method: 'PATCH',

12
  body: data

13
}

14


15
client.request(request)

16
  .then(([response, body]) => {

17
    console.log(response.statusCode);

18
    console.log(response.body);

19
  })

20
  .catch(error => {

21
    console.error(error);

22
  });
Update the remaining credits for a Subuser (Remove)Link to code sample: Update the remaining credits for a Subuser (Remove)
1
const client = require('@sendgrid/client');

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const subuser_name = "some_one";

5
const data = {

6
  "allocation_update": -10

7
};

8


9
const request = {

10
  url: `/v3/subusers/${subuser_name}/credits/remaining`,

11
  method: 'PATCH',

12
  body: data

13
}

14


15
client.request(request)

16
  .then(([response, body]) => {

17
    console.log(response.statusCode);

18
    console.log(response.body);

19
  })

20
  .catch(error => {

21
    console.error(error);

22
  });