<!--
{
  "availability" : [
    "iOS: 10.3.0 - 15.0.0",
    "iPadOS: 10.3.0 - 15.0.0",
    "macCatalyst: 13.1.0 - 15.0.0",
    "visionOS: 1.0.0 - 1.0.0",
    "watchOS: 3.2.0 - 8.0.0"
  ],
  "documentType" : "symbol",
  "framework" : "Intents",
  "identifier" : "/documentation/Intents/INBillDetails/paymentStatus",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "Intents"
    ],
    "preciseIdentifier" : "c:objc(cs)INBillDetails(py)paymentStatus"
  },
  "title" : "paymentStatus"
}
-->

# paymentStatus

The current status of the payment.

```
var paymentStatus: INPaymentStatus { get set }
```

## Discussion

Specify the current status of a scheduled payment. If the payment date of the bill is in the future, you typically set the payment status to [`INPaymentStatus.pending`](/documentation/Intents/INPaymentStatus/pending). For bills in the past, set the status to [`INPaymentStatus.completed`](/documentation/Intents/INPaymentStatus/completed) if payment was successful or to another value if the transaction wasn’t completed. If you haven’t scheduled the bill for payment, set its status to [`INPaymentStatus.unknown`](/documentation/Intents/INPaymentStatus/unknown).

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)