Fees

Buy and sell fees.

This API is experimental and not guaranteed to be backward compatible.

Retrieve a list of Fees entries

Retrieve a list of Fees entries.

This operation is experimental and not guaranteed to be backward compatible.

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

The collection items limit.

offset
integer >= 0

The collection items offset.

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

A fees list was retrieved successfully.

401

Unauthorized access, invalid credentials was used.

403

Access forbidden.

get/fees
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/fees?limit=1000&offset=0' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a fee entry

Create a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

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
type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
type
required
string
currency
required
string (CurrencyCode) 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>
Responses
201

Fee entry was created successfully.

401

Unauthorized access, invalid credentials was used.

403

Access forbidden.

422

Invalid data was sent.

post/fees
Request samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    }
}
Response samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    },
  • "createdTime": "2021-12-15T14:15:22Z",
  • "updatedTime": "2021-12-15T14:15:22Z",
}

Retrieve a fee entry

Retrieve a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

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

A fee was retrieved successfully.

401

Unauthorized access, invalid credentials was used.

403

Access forbidden.

404

Resource was not found.

get/fees/{id}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/fees/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    },
  • "createdTime": "2021-12-15T14:15:22Z",
  • "updatedTime": "2021-12-15T14:15:22Z",
}

Upsert a fee entry

Upsert a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

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
Request Body schema: application/json
type
required
string
Enum: "buy" "sell"
name
required
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

required
object (FeeFormula)
type
required
string
currency
required
string (CurrencyCode) 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>
Responses
200

Fee entry was updated successfully.

201

Fee entry was created successfully.

401

Unauthorized access, invalid credentials was used.

403

Access forbidden.

422

Invalid data was sent.

put/fees/{id}
Request samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    }
}
Response samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    },
  • "createdTime": "2021-12-15T14:15:22Z",
  • "updatedTime": "2021-12-15T14:15:22Z",
}

Patch a fee entry

Patch a fee entry.

This operation is experimental and not guaranteed to be backward compatible.

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
Request Body schema: application/json
type
string
Enum: "buy" "sell"
name
string [ 1 .. 255 ] characters

A fee name.

filter
string [ 1 .. 255 ] characters

A filter based on the transaction's properties which is used to determine when to apply the fee.

object (FeeFormula)
type
required
string
currency
required
string (CurrencyCode) 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>
Responses
200

Fee entry was patched successfully.

401

Unauthorized access, invalid credentials was used.

403

Access forbidden.

422

Invalid data was sent.

patch/fees/{id}
Request samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    }
}
Response samples
application/json

The transaction fees for Stripe. Discount rate fees are a separate record.

{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "buy",
  • "name": "Stripe transaction fees",
  • "filter": "type:sale,capture;result:approved;gatewayAccountId:stripe",
  • "formula": {
    },
  • "createdTime": "2021-12-15T14:15:22Z",
  • "updatedTime": "2021-12-15T14:15:22Z",
}