--- schema_version: "1" id: 588fa711783bbdab07bcb078a16183f21f9500e5d928645b9b90995e236f255a title: Coupon collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_coupon.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_coupon.htm source_site: developer.salesforce.com content_type: documentation content_hash: 3c3fda15de9720d07339ab8d7b292ec4e9c3dd58517943444f8e7e06949c6ce0 description: A coupon associated with a promotion. This object is available in API version 54.0 and later. --- # Coupon A coupon associated with a promotion. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Coupon object is available if the B2B Commerce or Marketing license is enabled. ## Fields | Field | Details | | --- | --- | | BusinessUnitId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The business unit associated with the coupon. This field is a relationship field. Relationship Name BusinessUnit Refers To BusinessUnit | | CouponCode | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Coupon code for the coupon. A buyer can use the coupon code to qualify for a promotion. | | CouponListName | Type string Properties Create, Filter, Nillable, Sort, Update Description Display name of the coupon. It’s different from the auto-generated system name and provides context for identifying the coupon's campaign purpose. It applies only to multi-code coupons. | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. | | Description | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the coupon. | | EndDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end date and time when the coupon is no longer active. | | IsNewCodePerAssignment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a new code is generated for each assignment. This field applies only to coupons of multi-code type. The default value is false. | | LastReferencedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view. | | LastViewedDate | Type datetime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the coupon. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner of this coupon. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PromotionId | Type reference Properties Create, Filter, Group, Sort Description ID of the promotion associated with the coupon. Optional for coupons of multi-code type. This is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion | | RedemptionLimitAllBuyers | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times this coupon can be used in total. This field is available in API version 61.0 and later. | | RedemptionLimitPerBuyer | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times this coupon can be used per customer. This field is available in API version 61.0 and later. | | StartDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The start date and time when the coupon is active. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Status of the coupon. Possible values are: - Active - Inactive The default value is Inactive | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of coupon. Use Single-Code or leave the field blank to create Commerce batch coupons with one shared code. Use Multi-Code for marketing campaigns to distribute unique codes to individual recipients. This field is available only when both Commerce and Marketing licenses are enabled. Possible values are: - Multi-Code - Single-Code | | Value | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the coupon. This field applies only to coupons of multi-code type. | ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [CouponChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object.