Application owners

Register an application

Register an application. It will appear publicly in the App Store:
An example app
Before you submit an app, read the App Store documentation.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
name
required
string

The application name.

logoId
required
string <= 50 characters

The file ID of the application logo.

authorName
required
string

The author's name.

authorLogoId
string <= 50 characters

The file ID of the author's logo.

tagline
required
string

The application's tagline.

description
required
string

The application description. Accepts markdown or simple text.

permissions
required
Array of strings <operationId>

The list of permissions available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum: "PostWebhookCredentialHash" "PostWebhook" "GetWebhook" "GetCustomer" "GetCustomerCollection" "GetInvoice" "GetInvoiceCollection" "GetPlan" "GetPlanCollection" "GetProduct" … 9 more
properties
object

Outlines the settings that app users can fill in when installing. Accepts JSON-schema drafts 4, 6 and 7.

Responses
201

Application was registered.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

409

Conflict.

422

Invalid data was sent.

post/applications
Request samples
application/json
{
  • "name": "string",
  • "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "authorName": "string",
  • "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "tagline": "string",
  • "description": "string",
  • "permissions": [
    ],
  • "properties": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "authorName": "string",
  • "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "tagline": "string",
  • "description": "string",
  • "status": "pending-approval",
  • "permissions": [
    ],
  • "properties": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve application instances

Retrieve application instances with predefined application identifier string.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Application instances were retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/applications/{id}/instances
Request samples
$applicationInstances = $client->applications()->loadInstances('applicationId');
Response samples
application/json
[
  • {
    }
]

Retrieve application instance

Retrieve application instance with predefined application and organization identifier strings.

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

The resource identifier string.

organizationId
required
string <= 50 characters ^[@~\-\.\w]+$

The organization identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Application instance was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/applications/{id}/instances/{organizationId}
Request samples
$applicationInstance = $client->applications()->loadInstance('applicationId', 'organizationId');
Response samples
application/json
{
  • "status": "enabling",
  • "settings": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string"
}

Application instance was disabledWebhook

Request
Security:
Request Body schema: application/json

Application instance disabled webhook request body resource.

organizationId
string <= 50 characters

The organization identifier string.

applicationId
string <= 50 characters

The organization identifier string.

eventType
string

Rebilly webhooks event type.

Value: "application-instance-disabled"
object
object (Application)
id
string <= 50 characters

The application identifier string.

name
required
string

The application name.

logoId
required
string <= 50 characters

The file ID of the application logo.

authorName
required
string

The author's name.

authorLogoId
string <= 50 characters

The file ID of the author's logo.

tagline
required
string

The application's tagline.

description
required
string

The application description. Accepts markdown or simple text.

status
string

The application status.

Enum: "pending-approval" "available" "disabled"
permissions
required
Array of strings <operationId>

The list of permissions available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum: "PostWebhookCredentialHash" "PostWebhook" "GetWebhook" "GetCustomer" "GetCustomerCollection" "GetInvoice" "GetInvoiceCollection" "GetPlan" "GetPlanCollection" "GetProduct" … 9 more
properties
object

Outlines the settings that app users can fill in when installing. Accepts JSON-schema drafts 4, 6 and 7.

createdTime
string <date-time>

Application created time.

updatedTime
string <date-time>

Application updated time.

Array of SelfLink (object) or ApplicationInstanceLink (object) or LogoUrlLink (object) or AuthorLogoUrlLink (object) non-empty

The links related to resource.

Array of ApplicationLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "application"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "applicationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "eventType": "application-instance-disabled",
  • "_embedded": {
    },
  • "_links": [
    ]
}

Application instance was enabledWebhook

Request
Security:
Request Body schema: application/json

Application instance enabled webhook request body resource.

organizationId
string <= 50 characters

The organization identifier string.

applicationId
string <= 50 characters

The organization identifier string.

eventType
string

Rebilly webhooks event type.

Value: "application-instance-enabled"
object
object (Application)
id
string <= 50 characters

The application identifier string.

name
required
string

The application name.

logoId
required
string <= 50 characters

The file ID of the application logo.

authorName
required
string

The author's name.

authorLogoId
string <= 50 characters

The file ID of the author's logo.

tagline
required
string

The application's tagline.

description
required
string

The application description. Accepts markdown or simple text.

status
string

The application status.

Enum: "pending-approval" "available" "disabled"
permissions
required
Array of strings <operationId>

The list of permissions available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum: "PostWebhookCredentialHash" "PostWebhook" "GetWebhook" "GetCustomer" "GetCustomerCollection" "GetInvoice" "GetInvoiceCollection" "GetPlan" "GetPlanCollection" "GetProduct" … 9 more
properties
object

Outlines the settings that app users can fill in when installing. Accepts JSON-schema drafts 4, 6 and 7.

createdTime
string <date-time>

Application created time.

updatedTime
string <date-time>

Application updated time.

Array of SelfLink (object) or ApplicationInstanceLink (object) or LogoUrlLink (object) or AuthorLogoUrlLink (object) non-empty

The links related to resource.

object (ApplicationInstance-2)
status
string

The application instance status.

Enum: "enabling" "enabled" "disabling" "disabled"
required
object
createdTime
string <date-time>

Application instance created time.

updatedTime
string <date-time>

Application instance updated time.

Array of SelfLink (object) non-empty

The links related to resource.

organizationId
string <= 50 characters

The merchant identifier string.

token
string

The session's token used to authenticate as the merchant.

Array of ApplicationLink (object) or ApplicationInstanceLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "application"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "applicationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "eventType": "application-instance-enabled",
  • "_embedded": {
    },
  • "_links": [
    ]
}