Organizations

Organization is an entity that represents you, or your company, as a merchant. You can have multiple organizations.

Note: Organizations are shared between "Live" and "Sandbox" environments.

Retrieve a list of organizations

Retrieve a list of organizations.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

Responses
200

A list of organizations was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/organizations
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/organizations?limit=1000&offset=0&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a organization

Create an organization.

Request
Security:
Request Body schema: application/json

Create Organization Request.

name
required
string

The organization name. It must be globally unique within Rebilly.

website
required
string <url>

The organization website address.

address
string <= 60 characters

The organization street address.

address2
string <= 60 characters

The organization street address.

city
string <= 45 characters

The organization city.

region
string <= 45 characters

The organization region (state).

country
required
string^[A-Z]{2}$

The organization country ISO Alpha-2 code.

postalCode
string <= 10 characters

The organization postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array
label
required
string <= 45 characters

The phone label.

value
required
string <= 50 characters

The phone value.

primary
boolean

True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array
label
required
string <= 45 characters

The email label.

value
required
string <email> <= 255 characters

The email value.

primary
boolean

True if email is primary.

taxDescriptor
string <= 255 characters

The organization's tax label. This will be displayed on the invoice.

invoiceTimeZone
string <= 50 characters

Invoice will use this time zone to display time otherwise UTC will be used. Example "America/New_York".

reportCurrency
required
string^[A-Z]{3}$

The currency used for reports. It can only be set upon organization creation.

object (OrganizationQuestionnaire)
role
string

The role of the owner.

monthlyTransactions
string

The amount of monthly processed transaction.

products
Array of strings

The list of products organization is interested in.

integrationType
string

What kind of integration organization looks for.

launchTiming
string

Desired time to go live.

Responses
201

Organization was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

409

The similar organization already exists.

422

Invalid data was sent.

post/organizations
Request samples
application/json
{
  • "name": "string",
  • "website": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "postalCode": "string",
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "taxDescriptor": "string",
  • "invoiceTimeZone": "string",
  • "reportCurrency": "string",
  • "questionnaire": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "postalCode": "string",
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "taxDescriptor": "string",
  • "invoiceTimeZone": "string",
  • "isPrimary": true,
  • "questionnaire": {
    },
  • "_links": [
    ]
}

Retrieve an organization

Retrieve a organization with specified identifier string.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Organization was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/organizations/{id}
Request samples
$organization = $client->organizations()->load('organizationId');
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "postalCode": "string",
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "taxDescriptor": "string",
  • "invoiceTimeZone": "string",
  • "isPrimary": true,
  • "questionnaire": {
    },
  • "_links": [
    ]
}

Update an organization

Update an organization.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Request Body schema: application/json

Create Organization Request.

name
string

The organization name. It must be globally unique within Rebilly.

address
string <= 60 characters

The organization street address.

address2
string <= 60 characters

The organization street address.

city
string <= 45 characters

The organization city.

region
string <= 45 characters

The organization region (state).

country
string^[A-Z]{2}$

The organization country ISO Alpha-2 code.

postalCode
string <= 10 characters

The organization postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array
label
required
string <= 45 characters

The phone label.

value
required
string <= 50 characters

The phone value.

primary
boolean

True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array
label
required
string <= 45 characters

The email label.

value
required
string <email> <= 255 characters

The email value.

primary
boolean

True if email is primary.

taxDescriptor
string <= 255 characters

The organization's tax label. This will be displayed on the invoice.

invoiceTimeZone
string <= 50 characters

Invoice will use this time zone to display time otherwise UTC will be used. Example "America/New_York".

object (OrganizationQuestionnaire)
role
string

The role of the owner.

monthlyTransactions
string

The amount of monthly processed transaction.

products
Array of strings

The list of products organization is interested in.

integrationType
string

What kind of integration organization looks for.

launchTiming
string

Desired time to go live.

Responses
200

Organization was updated.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

patch/organizations/{id}
Request samples
application/json
{
  • "name": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "postalCode": "string",
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "taxDescriptor": "string",
  • "invoiceTimeZone": "string",
  • "questionnaire": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "postalCode": "string",
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "taxDescriptor": "string",
  • "invoiceTimeZone": "string",
  • "isPrimary": true,
  • "questionnaire": {
    },
  • "_links": [
    ]
}