Question About Deprecated definition Field in LoyaltyProgramRewardTier

Hi Square Team,

I noticed that the definition field in the LoyaltyProgramRewardTier object has been marked as deprecated in the API documentation. However, I’m still able to retrieve this field when querying the API.


Could you please clarify when this field is expected to be fully removed from the API response?
We want to ensure our integration is prepared ahead of time.

Thank you for your support!

Best regards,
Murphy

:waving_hand: I’m Square Dev AI, here to help answer your question!
Based on the information you’ve provided, the following documentation will help answer your question:

Additional Documentation

Retrieve Loyalty Program
Loyalty Program
Manage Loyalty Rewards

If this documentation helped you find a solution, please check the box indicating that this reply solves the problem.
Otherwise one of our Developer Advocates will provide additional assistance shortly.

The definition field in the LoyaltyProgramRewardTier object is indeed marked as deprecated, but it’s not yet retired. Deprecated fields are typically removed when the item is retired in a future Square API version. However, the exact retirement date for this field hasn’t been specified yet.

In the meantime, you should start migrating to use the pricing_rule_reference field, which is the replacement for the deprecated definition field. This will ensure your integration remains functional when the definition field is eventually retired.

This answer was reviewed by @Bryan-Square.