Replace an organization's billing details

PUT

https://billing.ezghcloud.com/v1/organizations/{orgId}/billing-preferences

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid

Request bodyJSONrequired

contactobjectrequired
3 properties
- namestringrequired
  maxLength: 200, minLength: 1
- emailstringrequired
  format: email, maxLength: 254
- phoneoptionalstring | null
  maxLength: 32
addressobjectrequired
6 properties
- line1stringrequired
  maxLength: 200, minLength: 1
- citystringrequired
  maxLength: 100, minLength: 1
- countrystringrequired
  ISO 3166-1 alpha-2, case-insensitive; stored uppercase.
- line2optionalstring | null
  maxLength: 200
- regionoptionalstring | null
  maxLength: 100
- postalCodeoptionalstring | null
  maxLength: 20
billingMethodoptionalstripe
Default stripe.

Returns

200

OK

JSON

organizationIdstringrequired
billingMethodstringrequired
contactBillingContactornullrequired
2 variants
One of the following:
BillingContact
View BillingContact schema →
3 properties
namestringrequired
maxLength: 200, minLength: 1
emailstringrequired
format: email, maxLength: 254
phoneoptionalstring | null
maxLength: 32
null
addressBillingAddressornullrequired
2 variants
One of the following:
BillingAddress
View BillingAddress schema →
6 properties
line1stringrequired
maxLength: 200, minLength: 1
citystringrequired
maxLength: 100, minLength: 1
countrystringrequired
ISO 3166-1 alpha-2, case-insensitive; stored uppercase.

line2optionalstring | null
maxLength: 200
regionoptionalstring | null
maxLength: 100
postalCodeoptionalstring | null
maxLength: 20
null
updatedAtstring | nullrequired
format: date-time
updatedBystring | nullrequired
Who last saved them: a user's or bot's ID.
updatedByTypestring | nullrequired
user or bot.

400

invalid_request: the request is malformed (with issues), or invalid_cursor.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

401

unauthenticated: no valid credential.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

403

access_denied: the caller isn't allowed to (the message names the action); forbidden_origin: a cookie-authenticated write from another site.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

404

not_found: the organization (or one the caller doesn't belong to), or the resource, doesn't exist.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

409

invoice_in_progress: the organization's invoice is being issued; retry shortly.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

429

too_many_requests: slow down.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

503

unavailable, ledger_unavailable or payments_unavailable: retry later.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

Replace an organization's billing details

curl --request PUT \
  --url https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/billing-preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  },
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "billingMethod": "stripe"
}
'

const url = 'https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/billing-preferences';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    contact: {name: 'string', email: 'user@example.com', phone: 'string'},
    address: {
      line1: 'string',
      line2: 'string',
      city: 'string',
      region: 'string',
      postalCode: 'string',
      country: 'string'
    },
    billingMethod: 'stripe'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/billing-preferences"

payload = {
    "contact": {
        "name": "string",
        "email": "user@example.com",
        "phone": "string"
    },
    "address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
    },
    "billingMethod": "stripe"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "organizationId": "string",
  "billingMethod": "string",
  "contact": {
    "name": "string",
    "email": "user@example.com",
    "phone": "string"
  },
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedByType": "string"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}