---
title: "BenefitsInfo"
description: "Basic information about membership level benefits."
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/benefits-info'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/benefits-info.md'
---
# BenefitsInfo

Basic information about membership level benefits.

- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Object

## Type Signature

`BenefitsInfo`

## Fields

* `autoStackLimit`

  [Boolean](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/boolean.md)

  If the rewards allow stacking with automatic discounts.

* `benefitsDescription`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Description of the benefit.
  Only relevant when membershipType = PAID.
  Maximum 500 characters.

* `benefitsDetails`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  When rewardType is PERCENTAGE_DISCOUNT, CASH_VOUCHER, FREE_SHIPPING or POINTS, it represents the discount value for these benefits, such as x% off.

* `benefitsExpiryDateType`

  [BenefitsExpiryDateType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/benefits-expiry-date-type.md)

  The type of expiry time of benefits.
  Only valid when membershipType = PAID.

* `benefitsExpiryDateValue`

  [Int](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/int.md)

  Benefits expire x days after issuance, and return value x.
  Only relevant when benefitsExpiryDateType = SPECIFIC_DATE.

* `benefitsIcon`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The URL of the benefits icon

* `benefitsIssuranceType`

  [BenefitsIssuranceType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/benefits-issurance-type.md)

  The time when the benefits are issued.
  Only relevant when membershipType = PAID.

* `benefitsName`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Benefit name.
  Only relevant when membershipType = PAID.
  Maximum 25 characters

* `benefitsStatus`

  [BenefitsStatus](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/benefits-status.md)

  If the benefit is active.

* `benefitsUsageInstructionType`

  [BenefitsUsageInstructionType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/benefits-usage-instruction-type.md)

  Benefit usage condition type.

* `benefitsUsageInstructionValue`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Relevant only when rewardType  = PERCENTAGE_DISCOUNT or CASH_VOUCHER or FREE_SHIPPING. This indicates the value corresponding to the benefitsUsageInstructionType.

* `birthBenefitsReleaseType`

  [BirthBenefitsReleaseType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/birth-benefits-release-type.md)

  Birthday month benefit issurance time type.
  Relevant when rewardScene = BIRTH_BENEFITS.

* `codeStackLimit`

  [Boolean](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/boolean.md)

  If the rewards allow stacking with discount code.

* `daysBefore`

  [Int](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/int.md)

  The number of fixed days before the benefit is issued.
  Only relevant when birthBenefitsReleaseType = FIXED_BEFORE

* `fixedDate`

  [Int](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/int.md)

  The date of the monthly release.
  Only relevant if birthBenefitsReleaseType = FIXED_DATE

* `periodicallyDays`

  [Int](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/int.md)

  Benefits are issued every x days, and the value x is returned.
  Only relevant when benefitsIssuranceType = PERIODICALLY

* `periodicallyMonths`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Benefits are issued every x calendar months, and the value x is returned.
  Only relevant when benefitsIssuranceType = PERIODICALLY

* `productsApplicableType`

  [ProductsApplicableType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/products-applicable-type.md)

  Applicable product range.
  Relevant when rewardScene = BIRTH_BENEFITS, or rewardType = PERCENTAGE_DISCOUNT or CASH_VOUCHER or FREE_SHIPPING.

* `rewardType`

  [RewardType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/reward-type.md)

  Type of rewards

* `specificCategoryList`

  [[String]](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  A list of applicable product category IDs. Only relevant when productsApplicableType = SPECIFIC_CATEGORY.

* `specificDate`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Benefit issuance date. Format: MM-DD.
  Only relevant when benefitsIssuranceType = SPECIFIC_DATE

* `specificProductIds`

  [[String]](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Applicable product IDs. Only relevant when productsApplicableType = SPECIFIC_PRODUCT.

* `usageLimitsTimes`

  [Int](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/int.md)

  The number of the usage time limitation. Relevant only when usageLimitsType = LIMITS.

* `usageLimitsType`

  [UsageLimitsType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/usage-limits-type.md)

  If there is usage time limits.

## Schema Definition

```graphql
type BenefitsInfo { 
	autoStackLimit: Boolean
	benefitsDescription: String
	benefitsDetails: String
	benefitsExpiryDateType: BenefitsExpiryDateType
	benefitsExpiryDateValue: Int
	benefitsIcon: String
	benefitsIssuranceType: BenefitsIssuranceType
	benefitsName: String
	benefitsStatus: BenefitsStatus
	benefitsUsageInstructionType: BenefitsUsageInstructionType
	benefitsUsageInstructionValue: String
	birthBenefitsReleaseType: BirthBenefitsReleaseType
	codeStackLimit: Boolean
	daysBefore: Int
	fixedDate: Int
	periodicallyDays: Int
	periodicallyMonths: String
	productsApplicableType: ProductsApplicableType
	rewardType: RewardType
	specificCategoryList: [String]
	specificDate: String
	specificProductIds: [String]
	usageLimitsTimes: Int
	usageLimitsType: UsageLimitsType 
}
```

## Field from

* [Benefits](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/benefits.md).benefitsInfo

  Basic information about membership level benefits.

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes).