platform.grantPlatformOrganizationCredits

POST

/v1/platform/organizations/{organizationId}/credits/grants

const url = 'https://example.com/v1/platform/organizations/example/credits/grants';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"amountMicros":1,"note":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/platform/organizations/example/credits/grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amountMicros": 1, "note": "example" }'

Adds credits to an organization. A negative amount takes credits back.

Authorizations

token
session

Parameters

Path Parameters

organizationId

required

string

Request Body^required

application/json

object

amountMicros

required

integer

>= -9007199254740991 <= 9007199254740991

note

required

string

>= 1 characters <= 500 characters

Example ^generated

{
  "amountMicros": 1,
  "note": "example"
}

Responses

201

Success

application/json

object

required

string

amountMicros

required

integer

>= -9007199254740991 <= 9007199254740991

note

required

string

createdBy

required

string

createdAt

required

string

Example ^generated

{
  "id": "example",
  "amountMicros": 1,
  "note": "example",
  "createdBy": "example",
  "createdAt": "example"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

OrganizationNotFound

application/json

object

_tag

required

string

Allowed values: OrganizationNotFound

organizationId

required

string

Example

{
  "_tag": "OrganizationNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

503

PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PlatformUnavailable

Example

{
  "_tag": "PlatformUnavailable"
}

platform.grantPlatformOrganizationCredits

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

201

Example generated

401

Example

403

Example

404

Example

409

Example

503

Example

Request Body^required

Example ^generated

Example ^generated