Packages

Packages

Returns a package from the system by its ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the package to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The package was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The package could not be found.
429Limit exceeded... unable to retrieve package based on tenant limits.
500General server error.
get/packages/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/packages/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "display_in_portal_as": "string",
  • "membership_type_id": "string",
  • "renews_with_id": "string",
  • "does_not_receive_member_benefits": true,
  • "display_order": 0,
  • "enable_dues_proration": true,
  • "dues_proration": {
    },
  • "override_chapter_configuration": true,
  • "chapter_configuration": {
    },
  • "override_section_configuration": true,
  • "section_configuration": {
    },
  • "available_to": "new members",
  • "expiration_options": {
    },
  • "organizational_membership_options": {
    },
  • "bill_organization": true,
  • "update_dates_when": "invoice paid in full",
  • "suggest_donations": [
    ],
  • "product_tags_to_show_at_checkout": [
    ],
  • "id": "string",
  • "type": "membership-packages",
  • "name": "string",
  • "business_unit_id": "string",
  • "price": 0,
  • "member_price": 0,
  • "enable_product_confirmation_email": true,
  • "product_confirmation_email_options": {
    },
  • "enable_cancellation_fees": true,
  • "cancellation_fee": 0,
  • "enable_purchase_limits": true,
  • "purchase_limits": [
    ],
  • "enable_task_generation": true,
  • "tasks_to_generate": [
    ],
  • "enable_document_entitlement_creation": true,
  • "document_entitlements_to_create": [
    ],
  • "enable_purchasing_eligibility": true,
  • "purchasing_eligibility_criteria": { },
  • "enable_special_prices": true,
  • "special_prices": [
    ],
  • "allow_customer_to_choose_installment_plan": true,
  • "enable_bundled_products": true,
  • "installment_plan_options": [
    ],
  • "foreign_currency_prices": [
    ],
  • "is_active": true,
  • "bundled_products": [
    ],
  • "bundled_products_inventory_handling": "bundle",
  • "hide_from_portal": true,
  • "publish_to_portal": true,
  • "portal_options": {
    },
  • "notes": "string",
  • "enable_coupon_code_generation": true,
  • "coupon_codes": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Updates a package with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the package to update.

Request Body schema: application/json

The updated package that will be saved.

display_in_portal_as
string (Display In Portal As)

Override the portal display

membership_type_id
required
string (Membership Type)

The membership type this package is tied to

renews_with_id
string (Renews With)

The package that thiscc package should renew with - if null, the package renews with itself

does_not_receive_member_benefits
boolean (Does Not Receive Member Benefits)

If true, buying this package gives you member benefits

display_order
number <float> (Display Order)
enable_dues_proration
boolean (Enable Dues Proration)

Enable dues proration

required
object (Dues Proration)
override_chapter_configuration
boolean (Override Chapter Configuration)

Whether or not the chapter configuration is overridden

required
object (Chapter Configuration)

Allows you to override chapter configuration

override_section_configuration
boolean (Override Section Configuration)

Whether or not the section configuration is overridden

required
object (Section Configuration)

Allows you to override section configuration

available_to
string (Available To)

DEPRECATED - No longer supported, do not use

Enum: "new members" "renewing members" "both"
object (Expiration Options)
object (Organizational Membership Options)
bill_organization
boolean (Bill Organization)

If set, the organization should be billed for this package

update_dates_when
string (Update Dates When)
Enum: "invoice paid in full" "immediately" "never"
Array of objects

Allows you to suggestion donating to specific fundraising products upon checkout

product_tags_to_show_at_checkout
Array of strings (Product Tags To Show At Checkout)

Specific merchandise to show at checkout

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this miscellaneous product

type
string (Type)

The product type

Value: "membership-packages"
name
required
string (Name)

The name of the miscellaneous product

business_unit_id
required
string (Business Unit)

The business unit of the product

price
required
number <double> (Price)

The price of the product

member_price
number <double> (Member Price)

The price of the product for an active member

enable_product_confirmation_email
boolean (Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

required
object (Product Confirmation Email Options)
enable_cancellation_fees
boolean (Enable Cancellation Fees)

Whether or not cancellation fees are applicable

cancellation_fee
number <double> (Cancellation Fee)

Cancellation fees associated with this product

enable_purchase_limits
boolean (Enable Purchase Limits)

If true, purchase limits are in place for this product

Array of objects
enable_task_generation
boolean (Enable Task Generation)

If set, tasks will be generated

Array of objects
enable_document_entitlement_creation
boolean (Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

Array of objects
enable_purchasing_eligibility
boolean (Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

purchasing_eligibility_criteria
required
object (Purchasing Eligibility Criteria)
enable_special_prices
boolean (Enable Special Prices)

Whether to enable special pricing logic

required
Array of objects non-empty
allow_customer_to_choose_installment_plan
boolean (Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

enable_bundled_products
boolean (Enable Bundled Products)

Whether to enable bundled products

required
Array of objects non-empty
Array of objects
is_active
boolean (Is Active)

Whether this product is active/used

required
Array of objects non-empty
bundled_products_inventory_handling
string (Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum: "bundle" "each product"
hide_from_portal
boolean (Hide From Portal)

If set, this product should not be shown in the portal

publish_to_portal
boolean (Publish To Portal)

Whether or not this product should be available in the portal

object (Portal Options)
notes
string (Notes)

Notes

enable_coupon_code_generation
boolean (Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

required
Array of objects non-empty
Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Responses
200The package was updated successfully.
400The package supplied was not valid.
401Unauthorized.
403Forbidden.
404The package could not be found.
409The package could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve package based on tenant limits.
500General server error.
put/packages/{tenantId}/{id}
Request samples
application/json
{
  • "display_in_portal_as": "string",
  • "membership_type_id": "string",
  • "renews_with_id": "string",
  • "does_not_receive_member_benefits": true,
  • "display_order": 0,
  • "enable_dues_proration": true,
  • "dues_proration": {
    },
  • "override_chapter_configuration": true,
  • "chapter_configuration": {
    },
  • "override_section_configuration": true,
  • "section_configuration": {
    },
  • "available_to": "new members",
  • "expiration_options": {
    },
  • "organizational_membership_options": {
    },
  • "bill_organization": true,
  • "update_dates_when": "invoice paid in full",
  • "suggest_donations": [
    ],
  • "product_tags_to_show_at_checkout": [
    ],
  • "id": "string",
  • "type": "membership-packages",
  • "name": "string",
  • "business_unit_id": "string",
  • "price": 0,
  • "member_price": 0,
  • "enable_product_confirmation_email": true,
  • "product_confirmation_email_options": {
    },
  • "enable_cancellation_fees": true,
  • "cancellation_fee": 0,
  • "enable_purchase_limits": true,
  • "purchase_limits": [
    ],
  • "enable_task_generation": true,
  • "tasks_to_generate": [
    ],
  • "enable_document_entitlement_creation": true,
  • "document_entitlements_to_create": [
    ],
  • "enable_purchasing_eligibility": true,
  • "purchasing_eligibility_criteria": { },
  • "enable_special_prices": true,
  • "special_prices": [
    ],
  • "allow_customer_to_choose_installment_plan": true,
  • "enable_bundled_products": true,
  • "installment_plan_options": [
    ],
  • "foreign_currency_prices": [
    ],
  • "is_active": true,
  • "bundled_products": [
    ],
  • "bundled_products_inventory_handling": "bundle",
  • "hide_from_portal": true,
  • "publish_to_portal": true,
  • "portal_options": {
    },
  • "notes": "string",
  • "enable_coupon_code_generation": true,
  • "coupon_codes": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "display_in_portal_as": "string",
  • "membership_type_id": "string",
  • "renews_with_id": "string",
  • "does_not_receive_member_benefits": true,
  • "display_order": 0,
  • "enable_dues_proration": true,
  • "dues_proration": {
    },
  • "override_chapter_configuration": true,
  • "chapter_configuration": {
    },
  • "override_section_configuration": true,
  • "section_configuration": {
    },
  • "available_to": "new members",
  • "expiration_options": {
    },
  • "organizational_membership_options": {
    },
  • "bill_organization": true,
  • "update_dates_when": "invoice paid in full",
  • "suggest_donations": [
    ],
  • "product_tags_to_show_at_checkout": [
    ],
  • "id": "string",
  • "type": "membership-packages",
  • "name": "string",
  • "business_unit_id": "string",
  • "price": 0,
  • "member_price": 0,
  • "enable_product_confirmation_email": true,
  • "product_confirmation_email_options": {
    },
  • "enable_cancellation_fees": true,
  • "cancellation_fee": 0,
  • "enable_purchase_limits": true,
  • "purchase_limits": [
    ],
  • "enable_task_generation": true,
  • "tasks_to_generate": [
    ],
  • "enable_document_entitlement_creation": true,
  • "document_entitlements_to_create": [
    ],
  • "enable_purchasing_eligibility": true,
  • "purchasing_eligibility_criteria": { },
  • "enable_special_prices": true,
  • "special_prices": [
    ],
  • "allow_customer_to_choose_installment_plan": true,
  • "enable_bundled_products": true,
  • "installment_plan_options": [
    ],
  • "foreign_currency_prices": [
    ],
  • "is_active": true,
  • "bundled_products": [
    ],
  • "bundled_products_inventory_handling": "bundle",
  • "hide_from_portal": true,
  • "publish_to_portal": true,
  • "portal_options": {
    },
  • "notes": "string",
  • "enable_coupon_code_generation": true,
  • "coupon_codes": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Partially updates a package with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the package to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The package was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The package could not be found.
409The package could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve package based on tenant limits.
500General server error.
patch/packages/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "display_in_portal_as": "string",
  • "membership_type_id": "string",
  • "renews_with_id": "string",
  • "does_not_receive_member_benefits": true,
  • "display_order": 0,
  • "enable_dues_proration": true,
  • "dues_proration": {
    },
  • "override_chapter_configuration": true,
  • "chapter_configuration": {
    },
  • "override_section_configuration": true,
  • "section_configuration": {
    },
  • "available_to": "new members",
  • "expiration_options": {
    },
  • "organizational_membership_options": {
    },
  • "bill_organization": true,
  • "update_dates_when": "invoice paid in full",
  • "suggest_donations": [
    ],
  • "product_tags_to_show_at_checkout": [
    ],
  • "id": "string",
  • "type": "membership-packages",
  • "name": "string",
  • "business_unit_id": "string",
  • "price": 0,
  • "member_price": 0,
  • "enable_product_confirmation_email": true,
  • "product_confirmation_email_options": {
    },
  • "enable_cancellation_fees": true,
  • "cancellation_fee": 0,
  • "enable_purchase_limits": true,
  • "purchase_limits": [
    ],
  • "enable_task_generation": true,
  • "tasks_to_generate": [
    ],
  • "enable_document_entitlement_creation": true,
  • "document_entitlements_to_create": [
    ],
  • "enable_purchasing_eligibility": true,
  • "purchasing_eligibility_criteria": { },
  • "enable_special_prices": true,
  • "special_prices": [
    ],
  • "allow_customer_to_choose_installment_plan": true,
  • "enable_bundled_products": true,
  • "installment_plan_options": [
    ],
  • "foreign_currency_prices": [
    ],
  • "is_active": true,
  • "bundled_products": [
    ],
  • "bundled_products_inventory_handling": "bundle",
  • "hide_from_portal": true,
  • "publish_to_portal": true,
  • "portal_options": {
    },
  • "notes": "string",
  • "enable_coupon_code_generation": true,
  • "coupon_codes": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Returns a package from the system by its ID.

This method will delete a package with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the package to delete.

Responses
200The package was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The package could not be found.
409The package could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete package based on tenant limits.
500General server error.
delete/packages/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://membership.api.rhythmsoftware.com/packages/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Creates a new package record that does not already exist.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The package that you would like to be saved.

display_in_portal_as
string (Display In Portal As)

Override the portal display

membership_type_id
required
string (Membership Type)

The membership type this package is tied to

renews_with_id
string (Renews With)

The package that thiscc package should renew with - if null, the package renews with itself

does_not_receive_member_benefits
boolean (Does Not Receive Member Benefits)

If true, buying this package gives you member benefits

display_order
number <float> (Display Order)
enable_dues_proration
boolean (Enable Dues Proration)

Enable dues proration

required
object (Dues Proration)
override_chapter_configuration
boolean (Override Chapter Configuration)

Whether or not the chapter configuration is overridden

required
object (Chapter Configuration)

Allows you to override chapter configuration

override_section_configuration
boolean (Override Section Configuration)

Whether or not the section configuration is overridden

required
object (Section Configuration)

Allows you to override section configuration

available_to
string (Available To)

DEPRECATED - No longer supported, do not use

Enum: "new members" "renewing members" "both"
object (Expiration Options)
object (Organizational Membership Options)
bill_organization
boolean (Bill Organization)

If set, the organization should be billed for this package

update_dates_when
string (Update Dates When)
Enum: "invoice paid in full" "immediately" "never"
Array of objects

Allows you to suggestion donating to specific fundraising products upon checkout

product_tags_to_show_at_checkout
Array of strings (Product Tags To Show At Checkout)

Specific merchandise to show at checkout

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this miscellaneous product

type
string (Type)

The product type

Value: "membership-packages"
name
required
string (Name)

The name of the miscellaneous product

business_unit_id
required
string (Business Unit)

The business unit of the product

price
required
number <double> (Price)

The price of the product

member_price
number <double> (Member Price)

The price of the product for an active member

enable_product_confirmation_email
boolean (Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

required
object (Product Confirmation Email Options)
enable_cancellation_fees
boolean (Enable Cancellation Fees)

Whether or not cancellation fees are applicable

cancellation_fee
number <double> (Cancellation Fee)

Cancellation fees associated with this product

enable_purchase_limits
boolean (Enable Purchase Limits)

If true, purchase limits are in place for this product

Array of objects
enable_task_generation
boolean (Enable Task Generation)

If set, tasks will be generated

Array of objects
enable_document_entitlement_creation
boolean (Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

Array of objects
enable_purchasing_eligibility
boolean (Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

purchasing_eligibility_criteria
required
object (Purchasing Eligibility Criteria)
enable_special_prices
boolean (Enable Special Prices)

Whether to enable special pricing logic

required
Array of objects non-empty
allow_customer_to_choose_installment_plan
boolean (Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

enable_bundled_products
boolean (Enable Bundled Products)

Whether to enable bundled products

required
Array of objects non-empty
Array of objects
is_active
boolean (Is Active)

Whether this product is active/used

required
Array of objects non-empty
bundled_products_inventory_handling
string (Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum: "bundle" "each product"
hide_from_portal
boolean (Hide From Portal)

If set, this product should not be shown in the portal

publish_to_portal
boolean (Publish To Portal)

Whether or not this product should be available in the portal

object (Portal Options)
notes
string (Notes)

Notes

enable_coupon_code_generation
boolean (Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

required
Array of objects non-empty
Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Responses
200The package was saved successfully.
400The package you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The package could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add package based on tenant limits.
500General server error.
post/packages/{tenantId}
Request samples
application/json
{
  • "display_in_portal_as": "string",
  • "membership_type_id": "string",
  • "renews_with_id": "string",
  • "does_not_receive_member_benefits": true,
  • "display_order": 0,
  • "enable_dues_proration": true,
  • "dues_proration": {
    },
  • "override_chapter_configuration": true,
  • "chapter_configuration": {
    },
  • "override_section_configuration": true,
  • "section_configuration": {
    },
  • "available_to": "new members",
  • "expiration_options": {
    },
  • "organizational_membership_options": {
    },
  • "bill_organization": true,
  • "update_dates_when": "invoice paid in full",
  • "suggest_donations": [
    ],
  • "product_tags_to_show_at_checkout": [
    ],
  • "id": "string",
  • "type": "membership-packages",
  • "name": "string",
  • "business_unit_id": "string",
  • "price": 0,
  • "member_price": 0,
  • "enable_product_confirmation_email": true,
  • "product_confirmation_email_options": {
    },
  • "enable_cancellation_fees": true,
  • "cancellation_fee": 0,
  • "enable_purchase_limits": true,
  • "purchase_limits": [
    ],
  • "enable_task_generation": true,
  • "tasks_to_generate": [
    ],
  • "enable_document_entitlement_creation": true,
  • "document_entitlements_to_create": [
    ],
  • "enable_purchasing_eligibility": true,
  • "purchasing_eligibility_criteria": { },
  • "enable_special_prices": true,
  • "special_prices": [
    ],
  • "allow_customer_to_choose_installment_plan": true,
  • "enable_bundled_products": true,
  • "installment_plan_options": [
    ],
  • "foreign_currency_prices": [
    ],
  • "is_active": true,
  • "bundled_products": [
    ],
  • "bundled_products_inventory_handling": "bundle",
  • "hide_from_portal": true,
  • "publish_to_portal": true,
  • "portal_options": {
    },
  • "notes": "string",
  • "enable_coupon_code_generation": true,
  • "coupon_codes": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "display_in_portal_as": "string",
  • "membership_type_id": "string",
  • "renews_with_id": "string",
  • "does_not_receive_member_benefits": true,
  • "display_order": 0,
  • "enable_dues_proration": true,
  • "dues_proration": {
    },
  • "override_chapter_configuration": true,
  • "chapter_configuration": {
    },
  • "override_section_configuration": true,
  • "section_configuration": {
    },
  • "available_to": "new members",
  • "expiration_options": {
    },
  • "organizational_membership_options": {
    },
  • "bill_organization": true,
  • "update_dates_when": "invoice paid in full",
  • "suggest_donations": [
    ],
  • "product_tags_to_show_at_checkout": [
    ],
  • "id": "string",
  • "type": "membership-packages",
  • "name": "string",
  • "business_unit_id": "string",
  • "price": 0,
  • "member_price": 0,
  • "enable_product_confirmation_email": true,
  • "product_confirmation_email_options": {
    },
  • "enable_cancellation_fees": true,
  • "cancellation_fee": 0,
  • "enable_purchase_limits": true,
  • "purchase_limits": [
    ],
  • "enable_task_generation": true,
  • "tasks_to_generate": [
    ],
  • "enable_document_entitlement_creation": true,
  • "document_entitlements_to_create": [
    ],
  • "enable_purchasing_eligibility": true,
  • "purchasing_eligibility_criteria": { },
  • "enable_special_prices": true,
  • "special_prices": [
    ],
  • "allow_customer_to_choose_installment_plan": true,
  • "enable_bundled_products": true,
  • "installment_plan_options": [
    ],
  • "foreign_currency_prices": [
    ],
  • "is_active": true,
  • "bundled_products": [
    ],
  • "bundled_products_inventory_handling": "bundle",
  • "hide_from_portal": true,
  • "publish_to_portal": true,
  • "portal_options": {
    },
  • "notes": "string",
  • "enable_coupon_code_generation": true,
  • "coupon_codes": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Gets all of the packages in the system.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The packageswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/packages/{tenantId}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/packages/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]