Membership

Membership (v1-2025-04-18)

The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.

Like most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

membership-v1.json

membership-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/

https://membership.api.rhythmsoftware.com/

Add On Products

Operations

Add On Types

Operations

Add Ons

Operations

App Reference Types

Operations

Application Groups

Operations

Application Processes

Operations

Application Status Reasons

Operations

Applications

Operations

Ballots

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Change Fees

Operations

Chapter Dues Products

Operations

Chapter Types

Operations

Chapters

Operations

Coupons

Operations

Gets all of the coupons in the system.

Request

This method will scan all coupons and and return them to the caller.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/coupons/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The couponswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

add_on_products_discount_infoobject(Add On Products Discount Info)required

add_on_products_discount_info.add_on_idsArray of strings(Add Ons)

The add ons

add_on_products_discount_info.add_on_type_idsArray of strings(Add On Types)

The add on type IDs

add_on_products_discount_info.amountnumber(float)(Amount)required

add_on_products_discount_info.methodstring(Method)

Enum"amount""percentage"

applies_tostring(Applies To)required

Enum"both""new members""renewing members"

apply_to_add_on_productsboolean(Apply To Add On Products)

This coupon should be applied to membership add on products

apply_to_chapter_duesboolean(Apply To Chapter Dues)

This coupon should be applied to chapter dues

apply_to_membership_packagesboolean(Apply To Membership Packages)

This coupon should be applied to membership packages

apply_to_section_duesboolean(Apply To Section Dues)

This coupon should be applied to section dues

chapter_dues_discount_infoobject(Chapter Dues Discount Info)required

chapter_dues_discount_info.amountnumber(float)(Amount)required

chapter_dues_discount_info.chapter_idsArray of strings(Chapters)

The chapter IDs

chapter_dues_discount_info.chapter_type_idsArray of strings(Chapter Types)

The chapter types

chapter_dues_discount_info.maximum_number_of_chaptersnumber(float)(Maximum Number Of Chapters)

The maximum # of chapters to apply this discount

chapter_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

code_generation_htmlstring(Code Generation Html)

HTML you can add into HTML generation for the code

custom_field_valuesArray of objects(Custom Field Values)

discount_methodstring(Discount Method)required

Enum"discount line item""inline discount"

discount_product_idstring(Discount Product)required

idstring(ID)^[\w|-]+$required

The unique, string identifier of this coupon

is_activeboolean(Is Active)

Whether or not this coupon is active

maximum_discountnumber(float)(Maximum Discount)

The optional maximum discount that this coupon can yield, irrespective of its configuration

membership_package_discount_infoobject(Membership Package Discount Info)required

membership_package_discount_info.amountnumber(float)(Amount)required

membership_package_discount_info.methodstring(Method)

Enum"amount""percentage"

membership_package_discount_info.package_idsArray of strings(Packages)

The package IDs to which this discount should apply

membership_package_discount_info.type_idsArray of strings(Types)

The membership type IDs to which this discount should apply

namestring(Name)required

The name of the coupon

section_dues_discount_infoobject(Section Dues Discount Info)required

section_dues_discount_info.amountnumber(float)(Amount)required

section_dues_discount_info.maximum_number_of_sectionsnumber(float)(Maximum Number Of Sections)

The maximum # of sections to apply this discount

section_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

section_dues_discount_info.section_idsArray of strings(Sections)

The section IDs

section_dues_discount_info.section_type_idsArray of strings(Section Types)

The section types

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

]

Response

application/json

[
  {
    "add_on_products_discount_info": { … },
    "applies_to": "both",
    "apply_to_add_on_products": true,
    "apply_to_chapter_dues": true,
    "apply_to_membership_packages": true,
    "apply_to_section_dues": true,
    "chapter_dues_discount_info": { … },
    "code_generation_html": "string",
    "custom_field_values": [ … ],
    "discount_method": "discount line item",
    "discount_product_id": "string",
    "id": "string",
    "is_active": true,
    "maximum_discount": 0.1,
    "membership_package_discount_info": { … },
    "name": "string",
    "section_dues_discount_info": { … },
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }
]

Creates a new coupon record that does not already exist.

Request

This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The coupon that you would like to be saved.

add_on_products_discount_infoobject(Add On Products Discount Info)required

add_on_products_discount_info.add_on_idsArray of strings(Add Ons)

The add ons

add_on_products_discount_info.add_on_type_idsArray of strings(Add On Types)

The add on type IDs

add_on_products_discount_info.amountnumber(float)(Amount)required

add_on_products_discount_info.methodstring(Method)

Enum"amount""percentage"

applies_tostring(Applies To)required

Enum"both""new members""renewing members"

apply_to_add_on_productsboolean(Apply To Add On Products)

This coupon should be applied to membership add on products

apply_to_chapter_duesboolean(Apply To Chapter Dues)

This coupon should be applied to chapter dues

apply_to_membership_packagesboolean(Apply To Membership Packages)

This coupon should be applied to membership packages

apply_to_section_duesboolean(Apply To Section Dues)

This coupon should be applied to section dues

chapter_dues_discount_infoobject(Chapter Dues Discount Info)required

chapter_dues_discount_info.amountnumber(float)(Amount)required

chapter_dues_discount_info.chapter_idsArray of strings(Chapters)

The chapter IDs

chapter_dues_discount_info.chapter_type_idsArray of strings(Chapter Types)

The chapter types

chapter_dues_discount_info.maximum_number_of_chaptersnumber(float)(Maximum Number Of Chapters)

The maximum # of chapters to apply this discount

chapter_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

code_generation_htmlstring(Code Generation Html)

HTML you can add into HTML generation for the code

custom_field_valuesArray of objects(Custom Field Values)

discount_methodstring(Discount Method)required

Enum"discount line item""inline discount"

discount_product_idstring(Discount Product)required

idstring(ID)^[\w|-]+$required

The unique, string identifier of this coupon

is_activeboolean(Is Active)

Whether or not this coupon is active

maximum_discountnumber(float)(Maximum Discount)

The optional maximum discount that this coupon can yield, irrespective of its configuration

membership_package_discount_infoobject(Membership Package Discount Info)required

membership_package_discount_info.amountnumber(float)(Amount)required

membership_package_discount_info.methodstring(Method)

Enum"amount""percentage"

membership_package_discount_info.package_idsArray of strings(Packages)

The package IDs to which this discount should apply

membership_package_discount_info.type_idsArray of strings(Types)

The membership type IDs to which this discount should apply

namestring(Name)required

The name of the coupon

section_dues_discount_infoobject(Section Dues Discount Info)required

section_dues_discount_info.amountnumber(float)(Amount)required

section_dues_discount_info.maximum_number_of_sectionsnumber(float)(Maximum Number Of Sections)

The maximum # of sections to apply this discount

section_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

section_dues_discount_info.section_idsArray of strings(Sections)

The section IDs

section_dues_discount_info.section_type_idsArray of strings(Section Types)

The section types

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/coupons/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "add_on_products_discount_info": {
      "add_on_ids": [
        "string"
      ],
      "add_on_type_ids": [
        "string"
      ],
      "amount": 0.1,
      "method": "amount"
    },
    "applies_to": "both",
    "apply_to_add_on_products": true,
    "apply_to_chapter_dues": true,
    "apply_to_membership_packages": true,
    "apply_to_section_dues": true,
    "chapter_dues_discount_info": {
      "amount": 0.1,
      "chapter_ids": [
        "string"
      ],
      "chapter_type_ids": [
        "string"
      ],
      "maximum_number_of_chapters": 0.1,
      "method": "amount"
    },
    "code_generation_html": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "discount_method": "discount line item",
    "discount_product_id": "string",
    "id": "string",
    "is_active": true,
    "maximum_discount": 0.1,
    "membership_package_discount_info": {
      "amount": 0.1,
      "method": "amount",
      "package_ids": [
        "string"
      ],
      "type_ids": [
        "string"
      ]
    },
    "name": "string",
    "section_dues_discount_info": {
      "amount": 0.1,
      "maximum_number_of_sections": 0.1,
      "method": "amount",
      "section_ids": [
        "string"
      ],
      "section_type_ids": [
        "string"
      ]
    },
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The coupon was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

add_on_products_discount_infoobject(Add On Products Discount Info)required

add_on_products_discount_info.add_on_idsArray of strings(Add Ons)

The add ons

add_on_products_discount_info.add_on_type_idsArray of strings(Add On Types)

The add on type IDs

add_on_products_discount_info.amountnumber(float)(Amount)required

add_on_products_discount_info.methodstring(Method)

Enum"amount""percentage"

applies_tostring(Applies To)required

Enum"both""new members""renewing members"

apply_to_add_on_productsboolean(Apply To Add On Products)

This coupon should be applied to membership add on products

apply_to_chapter_duesboolean(Apply To Chapter Dues)

This coupon should be applied to chapter dues

apply_to_membership_packagesboolean(Apply To Membership Packages)

This coupon should be applied to membership packages

apply_to_section_duesboolean(Apply To Section Dues)

This coupon should be applied to section dues

chapter_dues_discount_infoobject(Chapter Dues Discount Info)required

chapter_dues_discount_info.amountnumber(float)(Amount)required

chapter_dues_discount_info.chapter_idsArray of strings(Chapters)

The chapter IDs

chapter_dues_discount_info.chapter_type_idsArray of strings(Chapter Types)

The chapter types

chapter_dues_discount_info.maximum_number_of_chaptersnumber(float)(Maximum Number Of Chapters)

The maximum # of chapters to apply this discount

chapter_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

code_generation_htmlstring(Code Generation Html)

HTML you can add into HTML generation for the code

custom_field_valuesArray of objects(Custom Field Values)

discount_methodstring(Discount Method)required

Enum"discount line item""inline discount"

discount_product_idstring(Discount Product)required

idstring(ID)^[\w|-]+$required

The unique, string identifier of this coupon

is_activeboolean(Is Active)

Whether or not this coupon is active

maximum_discountnumber(float)(Maximum Discount)

The optional maximum discount that this coupon can yield, irrespective of its configuration

membership_package_discount_infoobject(Membership Package Discount Info)required

membership_package_discount_info.amountnumber(float)(Amount)required

membership_package_discount_info.methodstring(Method)

Enum"amount""percentage"

membership_package_discount_info.package_idsArray of strings(Packages)

The package IDs to which this discount should apply

membership_package_discount_info.type_idsArray of strings(Types)

The membership type IDs to which this discount should apply

namestring(Name)required

The name of the coupon

section_dues_discount_infoobject(Section Dues Discount Info)required

section_dues_discount_info.amountnumber(float)(Amount)required

section_dues_discount_info.maximum_number_of_sectionsnumber(float)(Maximum Number Of Sections)

The maximum # of sections to apply this discount

section_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

section_dues_discount_info.section_idsArray of strings(Sections)

The section IDs

section_dues_discount_info.section_type_idsArray of strings(Section Types)

The section types

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "add_on_products_discount_info": {
    "add_on_ids": [ … ],
    "add_on_type_ids": [ … ],
    "amount": 0.1,
    "method": "amount"
  },
  "applies_to": "both",
  "apply_to_add_on_products": true,
  "apply_to_chapter_dues": true,
  "apply_to_membership_packages": true,
  "apply_to_section_dues": true,
  "chapter_dues_discount_info": {
    "amount": 0.1,
    "chapter_ids": [ … ],
    "chapter_type_ids": [ … ],
    "maximum_number_of_chapters": 0.1,
    "method": "amount"
  },
  "code_generation_html": "string",
  "custom_field_values": [
    { … }
  ],
  "discount_method": "discount line item",
  "discount_product_id": "string",
  "id": "string",
  "is_active": true,
  "maximum_discount": 0.1,
  "membership_package_discount_info": {
    "amount": 0.1,
    "method": "amount",
    "package_ids": [ … ],
    "type_ids": [ … ]
  },
  "name": "string",
  "section_dues_discount_info": {
    "amount": 0.1,
    "maximum_number_of_sections": 0.1,
    "method": "amount",
    "section_ids": [ … ],
    "section_type_ids": [ … ]
  },
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/coupons/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a coupon from the system by its ID.

Request

This method will delete a coupon with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the coupon to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/coupons/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The coupon was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a coupon from the system by its ID.

Request

This method will look up a coupon by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the coupon to return.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/coupons/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The coupon was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

add_on_products_discount_infoobject(Add On Products Discount Info)required

add_on_products_discount_info.add_on_idsArray of strings(Add Ons)

The add ons

add_on_products_discount_info.add_on_type_idsArray of strings(Add On Types)

The add on type IDs

add_on_products_discount_info.amountnumber(float)(Amount)required

add_on_products_discount_info.methodstring(Method)

Enum"amount""percentage"

applies_tostring(Applies To)required

Enum"both""new members""renewing members"

apply_to_add_on_productsboolean(Apply To Add On Products)

This coupon should be applied to membership add on products

apply_to_chapter_duesboolean(Apply To Chapter Dues)

This coupon should be applied to chapter dues

apply_to_membership_packagesboolean(Apply To Membership Packages)

This coupon should be applied to membership packages

apply_to_section_duesboolean(Apply To Section Dues)

This coupon should be applied to section dues

chapter_dues_discount_infoobject(Chapter Dues Discount Info)required

chapter_dues_discount_info.amountnumber(float)(Amount)required

chapter_dues_discount_info.chapter_idsArray of strings(Chapters)

The chapter IDs

chapter_dues_discount_info.chapter_type_idsArray of strings(Chapter Types)

The chapter types

chapter_dues_discount_info.maximum_number_of_chaptersnumber(float)(Maximum Number Of Chapters)

The maximum # of chapters to apply this discount

chapter_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

code_generation_htmlstring(Code Generation Html)

HTML you can add into HTML generation for the code

custom_field_valuesArray of objects(Custom Field Values)

discount_methodstring(Discount Method)required

Enum"discount line item""inline discount"

discount_product_idstring(Discount Product)required

idstring(ID)^[\w|-]+$required

The unique, string identifier of this coupon

is_activeboolean(Is Active)

Whether or not this coupon is active

maximum_discountnumber(float)(Maximum Discount)

The optional maximum discount that this coupon can yield, irrespective of its configuration

membership_package_discount_infoobject(Membership Package Discount Info)required

membership_package_discount_info.amountnumber(float)(Amount)required

membership_package_discount_info.methodstring(Method)

Enum"amount""percentage"

membership_package_discount_info.package_idsArray of strings(Packages)

The package IDs to which this discount should apply

membership_package_discount_info.type_idsArray of strings(Types)

The membership type IDs to which this discount should apply

namestring(Name)required

The name of the coupon

section_dues_discount_infoobject(Section Dues Discount Info)required

section_dues_discount_info.amountnumber(float)(Amount)required

section_dues_discount_info.maximum_number_of_sectionsnumber(float)(Maximum Number Of Sections)

The maximum # of sections to apply this discount

section_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

section_dues_discount_info.section_idsArray of strings(Sections)

The section IDs

section_dues_discount_info.section_type_idsArray of strings(Section Types)

The section types

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "add_on_products_discount_info": {
    "add_on_ids": [ … ],
    "add_on_type_ids": [ … ],
    "amount": 0.1,
    "method": "amount"
  },
  "applies_to": "both",
  "apply_to_add_on_products": true,
  "apply_to_chapter_dues": true,
  "apply_to_membership_packages": true,
  "apply_to_section_dues": true,
  "chapter_dues_discount_info": {
    "amount": 0.1,
    "chapter_ids": [ … ],
    "chapter_type_ids": [ … ],
    "maximum_number_of_chapters": 0.1,
    "method": "amount"
  },
  "code_generation_html": "string",
  "custom_field_values": [
    { … }
  ],
  "discount_method": "discount line item",
  "discount_product_id": "string",
  "id": "string",
  "is_active": true,
  "maximum_discount": 0.1,
  "membership_package_discount_info": {
    "amount": 0.1,
    "method": "amount",
    "package_ids": [ … ],
    "type_ids": [ … ]
  },
  "name": "string",
  "section_dues_discount_info": {
    "amount": 0.1,
    "maximum_number_of_sections": 0.1,
    "method": "amount",
    "section_ids": [ … ],
    "section_type_ids": [ … ]
  },
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Partially updates a coupon with the specified ID.

Request

This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the coupon to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/coupons/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The coupon was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

add_on_products_discount_infoobject(Add On Products Discount Info)required

add_on_products_discount_info.add_on_idsArray of strings(Add Ons)

The add ons

add_on_products_discount_info.add_on_type_idsArray of strings(Add On Types)

The add on type IDs

add_on_products_discount_info.amountnumber(float)(Amount)required

add_on_products_discount_info.methodstring(Method)

Enum"amount""percentage"

applies_tostring(Applies To)required

Enum"both""new members""renewing members"

apply_to_add_on_productsboolean(Apply To Add On Products)

This coupon should be applied to membership add on products

apply_to_chapter_duesboolean(Apply To Chapter Dues)

This coupon should be applied to chapter dues

apply_to_membership_packagesboolean(Apply To Membership Packages)

This coupon should be applied to membership packages

apply_to_section_duesboolean(Apply To Section Dues)

This coupon should be applied to section dues

chapter_dues_discount_infoobject(Chapter Dues Discount Info)required

chapter_dues_discount_info.amountnumber(float)(Amount)required

chapter_dues_discount_info.chapter_idsArray of strings(Chapters)

The chapter IDs

chapter_dues_discount_info.chapter_type_idsArray of strings(Chapter Types)

The chapter types

chapter_dues_discount_info.maximum_number_of_chaptersnumber(float)(Maximum Number Of Chapters)

The maximum # of chapters to apply this discount

chapter_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

code_generation_htmlstring(Code Generation Html)

HTML you can add into HTML generation for the code

custom_field_valuesArray of objects(Custom Field Values)

discount_methodstring(Discount Method)required

Enum"discount line item""inline discount"

discount_product_idstring(Discount Product)required

idstring(ID)^[\w|-]+$required

The unique, string identifier of this coupon

is_activeboolean(Is Active)

Whether or not this coupon is active

maximum_discountnumber(float)(Maximum Discount)

The optional maximum discount that this coupon can yield, irrespective of its configuration

membership_package_discount_infoobject(Membership Package Discount Info)required

membership_package_discount_info.amountnumber(float)(Amount)required

membership_package_discount_info.methodstring(Method)

Enum"amount""percentage"

membership_package_discount_info.package_idsArray of strings(Packages)

The package IDs to which this discount should apply

membership_package_discount_info.type_idsArray of strings(Types)

The membership type IDs to which this discount should apply

namestring(Name)required

The name of the coupon

section_dues_discount_infoobject(Section Dues Discount Info)required

section_dues_discount_info.amountnumber(float)(Amount)required

section_dues_discount_info.maximum_number_of_sectionsnumber(float)(Maximum Number Of Sections)

The maximum # of sections to apply this discount

section_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

section_dues_discount_info.section_idsArray of strings(Sections)

The section IDs

section_dues_discount_info.section_type_idsArray of strings(Section Types)

The section types

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "add_on_products_discount_info": {
    "add_on_ids": [ … ],
    "add_on_type_ids": [ … ],
    "amount": 0.1,
    "method": "amount"
  },
  "applies_to": "both",
  "apply_to_add_on_products": true,
  "apply_to_chapter_dues": true,
  "apply_to_membership_packages": true,
  "apply_to_section_dues": true,
  "chapter_dues_discount_info": {
    "amount": 0.1,
    "chapter_ids": [ … ],
    "chapter_type_ids": [ … ],
    "maximum_number_of_chapters": 0.1,
    "method": "amount"
  },
  "code_generation_html": "string",
  "custom_field_values": [
    { … }
  ],
  "discount_method": "discount line item",
  "discount_product_id": "string",
  "id": "string",
  "is_active": true,
  "maximum_discount": 0.1,
  "membership_package_discount_info": {
    "amount": 0.1,
    "method": "amount",
    "package_ids": [ … ],
    "type_ids": [ … ]
  },
  "name": "string",
  "section_dues_discount_info": {
    "amount": 0.1,
    "maximum_number_of_sections": 0.1,
    "method": "amount",
    "section_ids": [ … ],
    "section_type_ids": [ … ]
  },
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Updates a coupon with the specified ID.

Request

This method will update an existing coupon with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the coupon to update.

Bodyapplication/jsonrequired

The updated coupon that will be saved.

add_on_products_discount_infoobject(Add On Products Discount Info)required

add_on_products_discount_info.add_on_idsArray of strings(Add Ons)

The add ons

add_on_products_discount_info.add_on_type_idsArray of strings(Add On Types)

The add on type IDs

add_on_products_discount_info.amountnumber(float)(Amount)required

add_on_products_discount_info.methodstring(Method)

Enum"amount""percentage"

applies_tostring(Applies To)required

Enum"both""new members""renewing members"

apply_to_add_on_productsboolean(Apply To Add On Products)

This coupon should be applied to membership add on products

apply_to_chapter_duesboolean(Apply To Chapter Dues)

This coupon should be applied to chapter dues

apply_to_membership_packagesboolean(Apply To Membership Packages)

This coupon should be applied to membership packages

apply_to_section_duesboolean(Apply To Section Dues)

This coupon should be applied to section dues

chapter_dues_discount_infoobject(Chapter Dues Discount Info)required

chapter_dues_discount_info.amountnumber(float)(Amount)required

chapter_dues_discount_info.chapter_idsArray of strings(Chapters)

The chapter IDs

chapter_dues_discount_info.chapter_type_idsArray of strings(Chapter Types)

The chapter types

chapter_dues_discount_info.maximum_number_of_chaptersnumber(float)(Maximum Number Of Chapters)

The maximum # of chapters to apply this discount

chapter_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

code_generation_htmlstring(Code Generation Html)

HTML you can add into HTML generation for the code

custom_field_valuesArray of objects(Custom Field Values)

discount_methodstring(Discount Method)required

Enum"discount line item""inline discount"

discount_product_idstring(Discount Product)required

idstring(ID)^[\w|-]+$required

The unique, string identifier of this coupon

is_activeboolean(Is Active)

Whether or not this coupon is active

maximum_discountnumber(float)(Maximum Discount)

The optional maximum discount that this coupon can yield, irrespective of its configuration

membership_package_discount_infoobject(Membership Package Discount Info)required

membership_package_discount_info.amountnumber(float)(Amount)required

membership_package_discount_info.methodstring(Method)

Enum"amount""percentage"

membership_package_discount_info.package_idsArray of strings(Packages)

The package IDs to which this discount should apply

membership_package_discount_info.type_idsArray of strings(Types)

The membership type IDs to which this discount should apply

namestring(Name)required

The name of the coupon

section_dues_discount_infoobject(Section Dues Discount Info)required

section_dues_discount_info.amountnumber(float)(Amount)required

section_dues_discount_info.maximum_number_of_sectionsnumber(float)(Maximum Number Of Sections)

The maximum # of sections to apply this discount

section_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

section_dues_discount_info.section_idsArray of strings(Sections)

The section IDs

section_dues_discount_info.section_type_idsArray of strings(Section Types)

The section types

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/coupons/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "add_on_products_discount_info": {
      "add_on_ids": [
        "string"
      ],
      "add_on_type_ids": [
        "string"
      ],
      "amount": 0.1,
      "method": "amount"
    },
    "applies_to": "both",
    "apply_to_add_on_products": true,
    "apply_to_chapter_dues": true,
    "apply_to_membership_packages": true,
    "apply_to_section_dues": true,
    "chapter_dues_discount_info": {
      "amount": 0.1,
      "chapter_ids": [
        "string"
      ],
      "chapter_type_ids": [
        "string"
      ],
      "maximum_number_of_chapters": 0.1,
      "method": "amount"
    },
    "code_generation_html": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "discount_method": "discount line item",
    "discount_product_id": "string",
    "id": "string",
    "is_active": true,
    "maximum_discount": 0.1,
    "membership_package_discount_info": {
      "amount": 0.1,
      "method": "amount",
      "package_ids": [
        "string"
      ],
      "type_ids": [
        "string"
      ]
    },
    "name": "string",
    "section_dues_discount_info": {
      "amount": 0.1,
      "maximum_number_of_sections": 0.1,
      "method": "amount",
      "section_ids": [
        "string"
      ],
      "section_type_ids": [
        "string"
      ]
    },
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The coupon was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

add_on_products_discount_infoobject(Add On Products Discount Info)required

add_on_products_discount_info.add_on_idsArray of strings(Add Ons)

The add ons

add_on_products_discount_info.add_on_type_idsArray of strings(Add On Types)

The add on type IDs

add_on_products_discount_info.amountnumber(float)(Amount)required

add_on_products_discount_info.methodstring(Method)

Enum"amount""percentage"

applies_tostring(Applies To)required

Enum"both""new members""renewing members"

apply_to_add_on_productsboolean(Apply To Add On Products)

This coupon should be applied to membership add on products

apply_to_chapter_duesboolean(Apply To Chapter Dues)

This coupon should be applied to chapter dues

apply_to_membership_packagesboolean(Apply To Membership Packages)

This coupon should be applied to membership packages

apply_to_section_duesboolean(Apply To Section Dues)

This coupon should be applied to section dues

chapter_dues_discount_infoobject(Chapter Dues Discount Info)required

chapter_dues_discount_info.amountnumber(float)(Amount)required

chapter_dues_discount_info.chapter_idsArray of strings(Chapters)

The chapter IDs

chapter_dues_discount_info.chapter_type_idsArray of strings(Chapter Types)

The chapter types

chapter_dues_discount_info.maximum_number_of_chaptersnumber(float)(Maximum Number Of Chapters)

The maximum # of chapters to apply this discount

chapter_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

code_generation_htmlstring(Code Generation Html)

HTML you can add into HTML generation for the code

custom_field_valuesArray of objects(Custom Field Values)

discount_methodstring(Discount Method)required

Enum"discount line item""inline discount"

discount_product_idstring(Discount Product)required

idstring(ID)^[\w|-]+$required

The unique, string identifier of this coupon

is_activeboolean(Is Active)

Whether or not this coupon is active

maximum_discountnumber(float)(Maximum Discount)

The optional maximum discount that this coupon can yield, irrespective of its configuration

membership_package_discount_infoobject(Membership Package Discount Info)required

membership_package_discount_info.amountnumber(float)(Amount)required

membership_package_discount_info.methodstring(Method)

Enum"amount""percentage"

membership_package_discount_info.package_idsArray of strings(Packages)

The package IDs to which this discount should apply

membership_package_discount_info.type_idsArray of strings(Types)

The membership type IDs to which this discount should apply

namestring(Name)required

The name of the coupon

section_dues_discount_infoobject(Section Dues Discount Info)required

section_dues_discount_info.amountnumber(float)(Amount)required

section_dues_discount_info.maximum_number_of_sectionsnumber(float)(Maximum Number Of Sections)

The maximum # of sections to apply this discount

section_dues_discount_info.methodstring(Method)

Enum"amount""percentage"

section_dues_discount_info.section_idsArray of strings(Sections)

The section IDs

section_dues_discount_info.section_type_idsArray of strings(Section Types)

The section types

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "add_on_products_discount_info": {
    "add_on_ids": [ … ],
    "add_on_type_ids": [ … ],
    "amount": 0.1,
    "method": "amount"
  },
  "applies_to": "both",
  "apply_to_add_on_products": true,
  "apply_to_chapter_dues": true,
  "apply_to_membership_packages": true,
  "apply_to_section_dues": true,
  "chapter_dues_discount_info": {
    "amount": 0.1,
    "chapter_ids": [ … ],
    "chapter_type_ids": [ … ],
    "maximum_number_of_chapters": 0.1,
    "method": "amount"
  },
  "code_generation_html": "string",
  "custom_field_values": [
    { … }
  ],
  "discount_method": "discount line item",
  "discount_product_id": "string",
  "id": "string",
  "is_active": true,
  "maximum_discount": 0.1,
  "membership_package_discount_info": {
    "amount": 0.1,
    "method": "amount",
    "package_ids": [ … ],
    "type_ids": [ … ]
  },
  "name": "string",
  "section_dues_discount_info": {
    "amount": 0.1,
    "maximum_number_of_sections": 0.1,
    "method": "amount",
    "section_ids": [ … ],
    "section_type_ids": [ … ]
  },
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Directories

Operations

Elections

Operations

Group Application Processes

Operations

Id Card Templates

Operations

Memberships

Operations

Packages

Operations

Query Definitions

Operations

Recurring Billing Runs

Operations

Section Dues Products

Operations

Section Types

Operations

Sections

Operations

Settings

Operations

Statistics

Operations

Status Reasons

Operations

Types

Operations

Membership (v1-2025-04-18)

Add On Products

Add On Types

Add Ons

App Reference Types

Application Groups

Application Processes

Application Status Reasons

Applications

Ballots

Billing Notices

Billing Run Actions

Billing Runs

Billing Templates

Change Fees

Chapter Dues Products

Chapter Types

Chapters

Coupons

Gets all of the coupons in the system.

Request

Responses

Was this helpful?

Creates a new coupon record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a coupon from the system by its ID.

Request

Responses

Was this helpful?

Returns a coupon from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a coupon with the specified ID.

Request

Responses

Was this helpful?

Updates a coupon with the specified ID.

RequestExpand all

Responses

Was this helpful?

Directories

Elections

Group Application Processes

Id Card Templates

Memberships

Packages

Query Definitions

Recurring Billing Runs

Section Dues Products

Section Types

Sections

Settings

Statistics

Status Reasons

Types

Request

Request

Request